diff --git a/.changeset/jsdoc-format-pattern-nullable.md b/.changeset/jsdoc-format-pattern-nullable.md new file mode 100644 index 000000000..4f337c22c --- /dev/null +++ b/.changeset/jsdoc-format-pattern-nullable.md @@ -0,0 +1,5 @@ +--- +"openapi-typescript": minor +--- + +Add JSDoc `@format`, `@pattern`, and `@nullable` tags to generated types. Previously, `format` was output as plain text (`Format: date-time`), and `pattern`/`nullable` were not included in JSDoc at all. These are now proper JSDoc tags that downstream tools like ts-to-zod can parse for runtime validation. diff --git a/packages/openapi-fetch/test/examples/schemas/github.d.ts b/packages/openapi-fetch/test/examples/schemas/github.d.ts index c63dd71bc..76f9cbf9a 100644 --- a/packages/openapi-fetch/test/examples/schemas/github.d.ts +++ b/packages/openapi-fetch/test/examples/schemas/github.d.ts @@ -18417,74 +18417,74 @@ export type webhooks = Record; export interface components { schemas: { root: { - /** Format: uri-template */ + /** @format uri-template */ current_user_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_authorizations_html_url: string; - /** Format: uri-template */ + /** @format uri-template */ authorizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ code_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ commit_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ emails_url: string; - /** Format: uri-template */ + /** @format uri-template */ emojis_url: string; - /** Format: uri-template */ + /** @format uri-template */ events_url: string; - /** Format: uri-template */ + /** @format uri-template */ feeds_url: string; - /** Format: uri-template */ + /** @format uri-template */ followers_url: string; - /** Format: uri-template */ + /** @format uri-template */ following_url: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url: string; /** - * Format: uri-template * @deprecated + * @format uri-template */ hub_url?: string; - /** Format: uri-template */ + /** @format uri-template */ issue_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ label_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ public_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ rate_limit_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ topic_search_url?: string; - /** Format: uri-template */ + /** @format uri-template */ user_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_organizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_search_url: string; }; /** @@ -18494,34 +18494,67 @@ export interface components { "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ vulnerability: { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range: string | null; - /** @description The package version that resolves the vulnerability. */ + /** + * @nullable + * @description The package version that resolves the vulnerability. + */ first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ + /** + * @nullable + * @description The functions in the package that are affected by the vulnerability. + */ readonly vulnerable_functions: string[] | null; }; + /** @nullable */ "cvss-severities": { + /** @nullable */ cvss_v3?: { - /** @description The CVSS 3 vector string. */ + /** + * @nullable + * @description The CVSS 3 vector string. + */ vector_string: string | null; - /** @description The CVSS 3 score. */ + /** + * @nullable + * @description The CVSS 3 score. + */ readonly score: number | null; } | null; + /** @nullable */ cvss_v4?: { - /** @description The CVSS 4 vector string. */ + /** + * @nullable + * @description The CVSS 4 vector string. + */ vector_string: string | null; - /** @description The CVSS 4 score. */ + /** + * @nullable + * @description The CVSS 4 score. + */ readonly score: number | null; } | null; } | null; - /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + /** + * @nullable + * @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). + */ "security-advisory-epss": { percentage?: number; percentile?: number; @@ -18531,37 +18564,42 @@ export interface components { * @description A GitHub user. */ "simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -18571,25 +18609,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -18609,23 +18647,30 @@ export interface components { "global-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id: string | null; /** @description The API URL for the advisory. */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The API URL for the repository advisory. + * @format uri */ readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ description: string | null; /** * @description The type of advisory. @@ -18638,10 +18683,12 @@ export interface components { */ severity: "critical" | "high" | "medium" | "low" | "unknown"; /** - * Format: uri + * @nullable * @description The URL of the advisory's source code. + * @format uri */ source_code_location: string | null; + /** @nullable */ readonly identifiers: { /** * @description The type of identifier. @@ -18651,50 +18698,68 @@ export interface components { /** @description The identifier value. */ value: string; }[] | null; + /** @nullable */ references: string[] | null; /** - * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + * @format date-time */ readonly github_reviewed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. * This field is only populated when the advisory is imported from the National Vulnerability Database. + * @format date-time */ readonly nvd_published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; - /** @description The products and respective version ranges affected by the advisory. */ + /** + * @nullable + * @description The products and respective version ranges affected by the advisory. + */ vulnerabilities: components["schemas"]["vulnerability"][] | null; + /** @nullable */ cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; epss?: components["schemas"]["security-advisory-epss"]; + /** @nullable */ cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description The users who contributed to the advisory. */ + /** + * @nullable + * @description The users who contributed to the advisory. + */ readonly credits: { user: components["schemas"]["simple-user"]; type: components["schemas"]["security-advisory-credit-types"]; @@ -18724,16 +18789,20 @@ export interface components { * @description An enterprise on GitHub. */ enterprise: { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -18754,20 +18823,23 @@ export interface components { */ slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ integration: { @@ -18791,26 +18863,29 @@ export interface components { * @example Probot Owners */ name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ updated_at: string; /** @@ -18844,15 +18919,18 @@ export interface components { installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; } | null; /** - * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook + * @format uri */ "webhook-config-url": string; /** @@ -18892,9 +18970,9 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z + * @format date-time */ delivered_at: string; /** @@ -18923,24 +19001,28 @@ export interface components { */ event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ throttled_at?: string | null; }; @@ -18949,10 +19031,14 @@ export interface components { * @description Scim Error */ "scim-error": { + /** @nullable */ message?: string | null; + /** @nullable */ documentation_url?: string | null; + /** @nullable */ detail?: string | null; status?: number; + /** @nullable */ scimType?: string | null; schemas?: string[]; }; @@ -18988,9 +19074,9 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z + * @format date-time */ delivered_at: string; /** @@ -19019,24 +19105,28 @@ export interface components { */ event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ throttled_at?: string | null; /** @@ -19045,21 +19135,33 @@ export interface components { */ url?: string; request: { - /** @description The request headers sent with the webhook delivery. */ + /** + * @nullable + * @description The request headers sent with the webhook delivery. + */ headers: { [key: string]: unknown; } | null; - /** @description The webhook payload. */ + /** + * @nullable + * @description The webhook payload. + */ payload: { [key: string]: unknown; } | null; }; response: { - /** @description The response headers received when the delivery was made. */ + /** + * @nullable + * @description The response headers received when the delivery was made. + */ headers: { [key: string]: unknown; } | null; - /** @description The response payload received. */ + /** + * @nullable + * @description The response payload received. + */ payload: string | null; }; }; @@ -19078,8 +19180,8 @@ export interface components { account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; requester: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; }; @@ -19337,40 +19439,46 @@ export interface components { }; /** * Simple User + * @nullable * @description A GitHub user. */ "nullable-simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -19380,25 +19488,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -19419,6 +19527,7 @@ export interface components { * @example 1 */ id: number; + /** @nullable */ account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -19426,18 +19535,18 @@ export interface components { */ repository_selection: "all" | "selected"; /** - * Format: uri * @example https://api.github.com/app/installations/1/access_tokens + * @format uri */ access_tokens_url: string; /** - * Format: uri * @example https://api.github.com/installation/repositories + * @format uri */ repositories_url: string; /** - * Format: uri * @example https://github.com/organizations/github/settings/installations/1 + * @format uri */ html_url: string; /** @example 1 */ @@ -19448,11 +19557,14 @@ export interface components { target_type: string; permissions: components["schemas"]["app-permissions"]; events: string[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -19466,13 +19578,20 @@ export interface components { /** @example github-actions */ app_slug: string; suspended_by: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at: string | null; - /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ + /** + * @nullable + * @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" + */ contact_email?: string | null; }; /** * License Simple + * @nullable * @description License Simple */ "nullable-license-simple": { @@ -19481,15 +19600,19 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; } | null; /** @@ -19498,9 +19621,9 @@ export interface components { */ repository: { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -19528,16 +19651,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -19559,28 +19685,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -19602,13 +19728,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -19622,30 +19748,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -19653,25 +19779,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -19743,18 +19872,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -19872,7 +20004,10 @@ export interface components { */ single_file_paths?: string[]; }; - /** Scoped Installation */ + /** + * Scoped Installation + * @nullable + */ "nullable-scoped-installation": { permissions: components["schemas"]["app-permissions"]; /** @@ -19880,7 +20015,10 @@ export interface components { * @enum {string} */ repository_selection: "all" | "selected"; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -19892,8 +20030,8 @@ export interface components { */ single_file_paths?: string[]; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repositories_url: string; account: components["schemas"]["simple-user"]; @@ -19903,32 +20041,45 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { - /** Format: int64 */ + /** @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ url: string; - /** @description A list of scopes that this authorization is in. */ + /** + * @nullable + * @description A list of scopes that this authorization is in. + */ scopes: string[] | null; token: string; + /** @nullable */ token_last_eight: string | null; + /** @nullable */ hashed_token: string | null; app: { client_id: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; + /** @nullable */ note: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ note_url: string | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; + /** @nullable */ fingerprint: string | null; user?: components["schemas"]["nullable-simple-user"]; installation?: components["schemas"]["nullable-scoped-installation"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; }; /** @@ -19947,9 +20098,9 @@ export interface components { */ full_name: string; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; /** @@ -19977,11 +20128,14 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://github.com/github + * @format uri */ html_url: string; - /** @example Github - Code thigns happen here */ + /** + * @nullable + * @example Github - Code thigns happen here + */ name: string | null; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; @@ -20065,11 +20219,13 @@ export interface components { */ feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ max_teams: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20100,9 +20256,10 @@ export interface components { */ language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ deadline: string | null; starter_code_repository: components["schemas"]["simple-classroom-repository"]; @@ -20118,13 +20275,13 @@ export interface components { /** @example octocat */ login: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; }; @@ -20206,11 +20363,13 @@ export interface components { */ feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ max_teams?: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20241,9 +20400,10 @@ export interface components { */ language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ deadline: string | null; classroom: components["schemas"]["simple-classroom"]; @@ -20320,8 +20480,8 @@ export interface components { /** @example Contributor Covenant */ name: string; /** - * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant + * @format uri */ url: string; /** @@ -20372,7 +20532,10 @@ export interface components { * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). */ body?: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; }; /** @description A code security configuration */ @@ -20423,14 +20586,21 @@ export interface components { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ code_scanning_default_setup_options?: { /** + * @nullable * @description Whether to use labeled runners or standard GitHub runners. * @enum {string|null} */ runner_type?: "standard" | "labeled" | "not_set" | null; - /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning when runner_type is 'labeled'. + */ runner_label?: string | null; } | null; /** @@ -20482,28 +20652,34 @@ export interface components { */ enforcement?: "enforced" | "unenforced"; /** - * Format: uri * @description The URL of the configuration + * @format uri */ url?: string; /** - * Format: uri * @description The URL of the configuration + * @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ "code-scanning-default-setup-options": { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ runner_type?: "standard" | "labeled" | "not_set"; - /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. + */ runner_label?: string | null; } | null; /** @description A list of default code security configurations */ @@ -20521,9 +20697,9 @@ export interface components { */ "simple-repository": { /** - * Format: int64 * @description A unique identifier of the repository. * @example 1296269 + * @format int64 */ id: number; /** @@ -20545,12 +20721,13 @@ export interface components { /** @description Whether the repository is private. */ private: boolean; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; /** + * @nullable * @description The repository description. * @example This your first repo! */ @@ -20558,9 +20735,9 @@ export interface components { /** @description Whether the repository is a fork. */ fork: boolean; /** - * Format: uri * @description The URL to get more information about the repository from the GitHub API. * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @@ -20609,33 +20786,33 @@ export interface components { */ contents_url: string; /** - * Format: uri * @description A template for the API URL to list the contributors to the repository. * @example https://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @description The API URL to list the deployments of the repository. * @example https://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @description The API URL to list the downloads on the repository. * @example https://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @description The API URL to list the events of the repository. * @example https://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @description The API URL to list the forks of the repository. * @example https://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @@ -20679,15 +20856,15 @@ export interface components { */ labels_url: string; /** - * Format: uri * @description The API URL to get information about the languages of the repository. * @example https://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @description The API URL to merge branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @@ -20711,9 +20888,9 @@ export interface components { */ releases_url: string; /** - * Format: uri * @description The API URL to list the stargazers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @@ -20722,27 +20899,27 @@ export interface components { */ statuses_url: string; /** - * Format: uri * @description The API URL to list the subscribers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @description The API URL to subscribe to notifications for this repository. * @example https://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @description The API URL to get information about tags on the repository. * @example https://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @description The API URL to list the teams on the repository. * @example https://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @@ -20751,9 +20928,9 @@ export interface components { */ trees_url: string; /** - * Format: uri * @description The API URL to list the hooks on the repository. * @example https://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; }; @@ -20785,7 +20962,10 @@ export interface components { readonly severity: "low" | "medium" | "high" | "critical"; /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ + /** + * @nullable + * @description Details pertaining to the package version that patches this vulnerability. + */ readonly first_patched_version: { /** @description The package version that patches this vulnerability. */ readonly identifier: string; @@ -20795,7 +20975,10 @@ export interface components { "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ + /** + * @nullable + * @description The unique CVE ID assigned to the advisory. + */ readonly cve_id: string | null; /** @description A short, plain text summary of the advisory. */ readonly summary: string; @@ -20812,7 +20995,10 @@ export interface components { readonly cvss: { /** @description The overall CVSS score of the advisory. */ readonly score: number; - /** @description The full CVSS vector string for the advisory. */ + /** + * @nullable + * @description The full CVSS vector string for the advisory. + */ readonly vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -20837,60 +21023,64 @@ export interface components { /** @description Links to additional advisory information. */ readonly references: { /** - * Format: uri * @description The URL of the reference. + * @format uri */ readonly url: string; }[]; /** - * Format: date-time * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly withdrawn_at: string | null; }; /** - * Format: uri * @description The REST API URL of the alert resource. + * @format uri */ "alert-url": string; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ "alert-html-url": string; /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-created-at": string; /** - * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-updated-at": string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-dismissed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-fixed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ @@ -20907,6 +21097,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -20921,19 +21112,24 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time + * @nullable * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "nullable-alert-updated-at": string | null; /** @@ -20942,6 +21138,7 @@ export interface components { */ "secret-scanning-alert-state": "open" | "resolved"; /** + * @nullable * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. * @enum {string|null} */ @@ -20953,15 +21150,16 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; @@ -20975,34 +21173,54 @@ export interface components { /** @description The secret that was detected. */ secret?: string; repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ + /** + * @nullable + * @description The comment that was optionally added when this alert was closed + */ resolution_comment?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ validity?: "active" | "inactive" | "unknown"; - /** @description Whether the secret was publicly leaked. */ + /** + * @nullable + * @description Whether the secret was publicly leaked. + */ publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. + */ multi_repo?: boolean | null; }; /** @@ -21013,30 +21231,32 @@ export interface components { id: number; login: string; display_login?: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ "nullable-milestone": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ labels_url: string; /** @example 1002604 */ @@ -21060,7 +21280,10 @@ export interface components { * @example v1.0 */ title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -21068,28 +21291,31 @@ export interface components { /** @example 8 */ closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ due_on: string | null; } | null; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ "nullable-integration": { @@ -21113,26 +21339,29 @@ export interface components { * @example Probot Owners */ name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ updated_at: string; /** @@ -21166,7 +21395,10 @@ export interface components { installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; @@ -21180,7 +21412,7 @@ export interface components { "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** Reaction Rollup */ "reaction-rollup": { - /** Format: uri */ + /** @format uri */ url: string; total_count: number; "+1": number; @@ -21203,23 +21435,23 @@ export interface components { * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ issue: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -21232,6 +21464,7 @@ export interface components { */ state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -21243,6 +21476,7 @@ export interface components { */ title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -21256,45 +21490,67 @@ export interface components { * ] */ labels: (string | { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ url?: string; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; default?: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; comments: number; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; draft?: boolean; closed_by?: components["schemas"]["nullable-simple-user"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21308,16 +21564,16 @@ export interface components { */ "issue-comment": { /** - * Format: int64 * @description Unique identifier of the issue comment * @example 42 + * @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ url: string; /** @@ -21327,20 +21583,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21352,12 +21608,13 @@ export interface components { */ event: { id: string; + /** @nullable */ type: string | null; actor: components["schemas"]["actor"]; repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; org?: components["schemas"]["actor"]; @@ -21368,6 +21625,7 @@ export interface components { pages?: { page_name?: string; title?: string; + /** @nullable */ summary?: string | null; action?: string; sha?: string; @@ -21375,7 +21633,10 @@ export interface components { }[]; }; public: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; }; /** @@ -21439,19 +21700,19 @@ export interface components { * @description Base Gist */ "base-gist": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -21468,15 +21729,16 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; + /** @nullable */ description: string | null; comments: number; comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; @@ -21489,7 +21751,7 @@ export interface components { */ "public-user": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; /** * @description discriminator enum property added by openapi-typescript @@ -21497,47 +21759,61 @@ export interface components { */ user_view_type: "public"; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; following_url: string; gists_url: string; starred_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; events_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; site_admin: boolean; + /** @nullable */ name: string | null; + /** @nullable */ company: string | null; + /** @nullable */ blog: string | null; + /** @nullable */ location: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ notification_email?: string | null; + /** @nullable */ hireable: boolean | null; + /** @nullable */ bio: string | null; + /** @nullable */ twitter_username?: string | null; public_repos: number; public_gists: number; followers: number; following: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; plan?: { collaborators: number; @@ -21563,14 +21839,14 @@ export interface components { "gist-history": { user?: components["schemas"]["nullable-simple-user"]; version?: string; - /** Format: date-time */ + /** @format date-time */ committed_at?: string; change_status?: { total?: number; additions?: number; deletions?: number; }; - /** Format: uri */ + /** @format uri */ url?: string; }; /** @@ -21578,37 +21854,44 @@ export interface components { * @description Gist Simple */ "gist-simple": { - /** @deprecated */ + /** + * @deprecated + * @nullable + */ forks?: { id?: string; - /** Format: uri */ + /** @format uri */ url?: string; user?: components["schemas"]["public-user"]; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }[] | null; - /** @deprecated */ + /** + * @deprecated + * @nullable + */ history?: components["schemas"]["gist-history"][] | null; /** * Gist + * @nullable * @description Gist */ fork_of?: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -21620,15 +21903,16 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; + /** @nullable */ description: string | null; comments: number; comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; @@ -21662,9 +21946,11 @@ export interface components { public?: boolean; created_at?: string; updated_at?: string; + /** @nullable */ description?: string | null; comments?: number; comments_enabled?: boolean; + /** @nullable */ user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -21680,8 +21966,8 @@ export interface components { /** @example MDExOkdpc3RDb21tZW50MQ== */ node_id: string; /** - * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + * @format uri */ url: string; /** @@ -21691,13 +21977,13 @@ export interface components { body: string; user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ updated_at: string; author_association: components["schemas"]["author-association"]; @@ -21708,8 +21994,8 @@ export interface components { */ "gist-commit": { /** - * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + * @format uri */ url: string; /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ @@ -21721,8 +22007,8 @@ export interface components { deletions?: number; }; /** - * Format: date-time * @example 2010-04-14T02:15:15Z + * @format date-time */ committed_at: string; }; @@ -21764,15 +22050,19 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; }; /** @@ -21784,18 +22074,22 @@ export interface components { key: string; /** @example MIT License */ name: string; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; /** - * Format: uri * @example http://choosealicense.com/licenses/mit/ + * @format uri */ html_url: string; /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ @@ -21857,13 +22151,13 @@ export interface components { */ "marketplace-listing-plan": { /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts + * @format uri */ accounts_url: string; /** @example 1313 */ @@ -21885,6 +22179,7 @@ export interface components { price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; /** @example true */ has_free_trial: boolean; + /** @nullable */ unit_name: string | null; /** @example published */ state: string; @@ -21906,20 +22201,26 @@ export interface components { id: number; login: string; organization_billing_email?: string; + /** @nullable */ email?: string | null; + /** @nullable */ marketplace_pending_change?: { is_installed?: boolean; effective_date?: string; + /** @nullable */ unit_count?: number | null; id?: number; plan?: components["schemas"]["marketplace-listing-plan"]; } | null; marketplace_purchase: { billing_cycle?: string; + /** @nullable */ next_billing_date?: string | null; is_installed?: boolean; + /** @nullable */ unit_count?: number | null; on_free_trial?: boolean; + /** @nullable */ free_trial_ends_on?: string | null; updated_at?: string; plan?: components["schemas"]["marketplace-listing-plan"]; @@ -22043,6 +22344,7 @@ export interface components { }; }; }; + /** @nullable */ "security-and-analysis": { advanced_security?: { /** @enum {string} */ @@ -22079,8 +22381,8 @@ export interface components { */ "minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -22092,16 +22394,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -22123,28 +22428,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -22165,13 +22470,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -22184,43 +22489,46 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ trees_url: string; clone_url?: string; + /** @nullable */ mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; svn_url?: string; + /** @nullable */ homepage?: string | null; + /** @nullable */ language?: string | null; forks_count?: number; stargazers_count?: number; @@ -22241,18 +22549,21 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at?: string | null; permissions?: { @@ -22269,6 +22580,7 @@ export interface components { subscribers_count?: number; network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ license?: { key?: string; name?: string; @@ -22303,6 +22615,7 @@ export interface components { reason: string; unread: boolean; updated_at: string; + /** @nullable */ last_read_at: string | null; url: string; /** @example https://api.github.com/notifications/threads/2/subscription */ @@ -22316,25 +22629,27 @@ export interface components { /** @example true */ subscribed: boolean; ignored: boolean; + /** @nullable */ reason: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-06T21:34:12Z + * @format date-time */ created_at: string | null; /** - * Format: uri * @example https://api.github.com/notifications/threads/1/subscription + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/notifications/threads/1 + * @format uri */ thread_url?: string; /** - * Format: uri * @example https://api.github.com/repos/1 + * @format uri */ repository_url?: string; }; @@ -22350,18 +22665,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22374,7 +22689,10 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; }; "billing-usage-report": { @@ -22415,18 +22733,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22439,25 +22757,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -22474,8 +22798,8 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** @example Organization */ @@ -22484,11 +22808,18 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; /** + * @nullable * @description The number of collaborators on private repositories. * * This field may be null if the number of private repositories is over 50,000. @@ -22496,8 +22827,9 @@ export interface components { */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -22507,10 +22839,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -22526,7 +22865,10 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; @@ -22596,18 +22938,22 @@ export interface components { */ secret_scanning_push_protection_custom_link_enabled?: boolean; /** + * @nullable * @description An optional URL string to display to contributors who are blocked from pushing a secret. * @example https://github.com/test-org/test-repo/blob/main/README.md */ secret_scanning_push_protection_custom_link?: string | null; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ archived_at: string | null; /** * @description Controls whether or not deploy keys may be added and used for repositories in the organization. @@ -22644,6 +22990,7 @@ export interface components { }; /** * GitHub-hosted runner image details. + * @nullable * @description Provides details of a hosted runner image */ "nullable-actions-hosted-runner-pool-image": { @@ -22767,9 +23114,10 @@ export interface components { /** @description The public IP ranges when public IP is enabled for the hosted runners. */ public_ips?: components["schemas"]["public-ip"][]; /** - * Format: date-time + * @nullable * @description The time at which the runner was last used, in ISO 8601 format. * @example 2022-10-09T23:39:01Z + * @format date-time */ last_active_on?: string | null; }; @@ -22981,9 +23329,9 @@ export interface components { */ token: string; /** - * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z + * @format date-time */ expires_at: string; /** @@ -22995,7 +23343,10 @@ export interface components { permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file?: string | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -23013,9 +23364,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -23023,8 +23374,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23068,15 +23419,15 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ updated_at: string; /** @@ -23085,14 +23436,17 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/variables/USERNAME/repositories + * @format uri */ selected_repositories_url?: string; }; /** @description The name of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-name": string; - /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + /** + * @nullable + * @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. + */ "code-scanning-analysis-tool-guid": string | null; /** * @description State of a code scanning alert. @@ -23105,33 +23459,43 @@ export interface components { */ "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; /** - * Format: uri * @description The REST API URL for fetching the list of instances for an alert. + * @format uri */ "alert-instances-url": string; /** + * @nullable * @description State of a code scanning alert. * @enum {string|null} */ "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** + * @nullable * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; - /** @description The dismissal comment associated with the dismissal of the alert. */ + /** + * @nullable + * @description The dismissal comment associated with the dismissal of the alert. + */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -23140,14 +23504,26 @@ export interface components { description?: string; /** @description A description of the rule used to detect the alert. */ full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; }; - /** @description The version of the tool used to generate the code scanning analysis. */ + /** + * @nullable + * @description The version of the tool used to generate the code scanning analysis. + */ "code-scanning-analysis-tool-version": string | null; "code-scanning-analysis-tool": { name?: components["schemas"]["code-scanning-analysis-tool-name"]; @@ -23174,6 +23550,7 @@ export interface components { end_column?: number; }; /** + * @nullable * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ @@ -23216,6 +23593,7 @@ export interface components { }; /** * Codespace machine + * @nullable * @description A description of the machine powering a codespace. */ "nullable-codespace-machine": { @@ -23250,6 +23628,7 @@ export interface components { */ cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -23262,8 +23641,8 @@ export interface components { */ codespace: { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -23272,11 +23651,13 @@ export interface components { */ name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -23286,29 +23667,31 @@ export interface components { repository: components["schemas"]["minimal-repository"]; machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ last_used_at: string; /** @@ -23318,8 +23701,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -23351,63 +23734,81 @@ export interface components { */ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ allowed_port_privacy_settings?: string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ retention_expires_at?: string | null; /** + * @nullable * @description The text to display to a user when a codespace has been stopped for a potentially actionable reason. * @example you've used 100% of your spending limit for Codespaces */ @@ -23424,13 +23825,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -23439,9 +23840,9 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23528,6 +23929,7 @@ export interface components { }; /** * Organization Simple + * @nullable * @description A GitHub organization. */ "nullable-organization-simple": { @@ -23538,18 +23940,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -23562,11 +23964,15 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; } | null; /** * Team Simple + * @nullable * @description Groups of organization members that gives permissions on specified repositories. */ "nullable-team-simple": { @@ -23578,9 +23984,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -23591,6 +23997,7 @@ export interface components { */ name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -23611,13 +24018,13 @@ export interface components { */ notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; /** @example justice-league */ @@ -23637,6 +24044,7 @@ export interface components { node_id: string; name: string; slug: string; + /** @nullable */ description: string | null; privacy?: string; notification_setting?: string; @@ -23648,15 +24056,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; @@ -23665,27 +24073,33 @@ export interface components { * @description Group of enterprise owners and/or members */ "enterprise-team": { - /** Format: int64 */ + /** @format int64 */ id: number; name: string; slug: string; - /** Format: uri */ + /** @format uri */ url: string; /** @example disabled | all */ sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + /** + * @nullable + * @example 62ab9291-fae2-468e-974b-7e45096d5021 + */ group_id?: string | null; - /** @example Justice League */ + /** + * @nullable + * @example Justice League + */ group_name?: string | null; /** - * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league + * @format uri */ html_url: string; members_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -23695,29 +24109,37 @@ export interface components { "copilot-seat-details": { assignee: components["schemas"]["simple-user"]; organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + /** + * @nullable + * @description The team through which the assignee is granted access to GitHub Copilot, if applicable. + */ assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** - * Format: date + * @nullable * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @format date */ pending_cancellation_date?: string | null; /** - * Format: date-time + * @nullable * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @format date-time */ last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + /** + * @nullable + * @description Last editor that was used by the user for a GitHub Copilot completion. + */ last_activity_editor?: string | null; /** - * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @format date-time */ created_at: string; /** - * Format: date-time * @deprecated * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @format date-time */ updated_at?: string; /** @@ -23726,7 +24148,10 @@ export interface components { */ plan_type?: "business" | "enterprise" | "unknown"; }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot editor code completions in the IDE. + */ "copilot-ide-code-completions": ({ /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ total_engaged_users?: number; @@ -23748,7 +24173,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date?: string | null; /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ total_engaged_users?: number; @@ -23774,7 +24202,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in the IDE. + */ "copilot-ide-chat": ({ /** @description Total number of users who prompted Copilot Chat in the IDE. */ total_engaged_users?: number; @@ -23789,7 +24220,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date?: string | null; /** @description The number of users who prompted Copilot Chat in the given editor and model. */ total_engaged_users?: number; @@ -23804,7 +24238,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in github.com + */ "copilot-dotcom-chat": ({ /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ total_engaged_users?: number; @@ -23814,7 +24251,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ + /** + * @nullable + * @description The training date for the custom model (if applicable). + */ custom_model_training_date?: string | null; /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ total_engaged_users?: number; @@ -23824,7 +24264,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot for pull requests. */ + /** + * @nullable + * @description Usage metrics for Copilot for pull requests. + */ "copilot-dotcom-pull-requests": ({ /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ total_engaged_users?: number; @@ -23840,7 +24283,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date?: string | null; /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ total_pr_summaries_created?: number; @@ -23857,8 +24303,8 @@ export interface components { */ "copilot-usage-metrics-day": { /** - * Format: date * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @format date */ date: string; /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ @@ -23878,8 +24324,8 @@ export interface components { */ "copilot-usage-metrics": { /** - * Format: date * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @format date */ day: string; /** @description The total number of Copilot code completion suggestions shown to users. */ @@ -23898,7 +24344,10 @@ export interface components { total_chat_turns?: number; /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ + /** + * @nullable + * @description Breakdown of Copilot code completions usage by language and editor + */ breakdown: ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ language?: string; @@ -23928,9 +24377,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -23938,8 +24387,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23961,12 +24410,13 @@ export interface components { }; /** * Minimal Repository + * @nullable * @description Minimal Repository */ "nullable-minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -23978,16 +24428,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -24009,28 +24462,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -24051,13 +24504,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -24070,43 +24523,46 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ trees_url: string; clone_url?: string; + /** @nullable */ mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; svn_url?: string; + /** @nullable */ homepage?: string | null; + /** @nullable */ language?: string | null; forks_count?: number; stargazers_count?: number; @@ -24127,18 +24583,21 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at?: string | null; permissions?: { @@ -24155,6 +24614,7 @@ export interface components { subscribers_count?: number; network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ license?: { key?: string; name?: string; @@ -24209,9 +24669,9 @@ export interface components { visibility: "private" | "public"; owner?: components["schemas"]["nullable-simple-user"]; repository?: components["schemas"]["nullable-minimal-repository"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24219,13 +24679,17 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { - /** Format: int64 */ + /** @format int64 */ id: number; + /** @nullable */ login: string | null; + /** @nullable */ email: string | null; role: string; created_at: string; + /** @nullable */ failed_at?: string | null; + /** @nullable */ failed_reason?: string | null; inviter: components["schemas"]["simple-user"]; team_count: number; @@ -24244,18 +24708,18 @@ export interface components { /** @example 1 */ id: number; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings + * @format uri */ ping_url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries + * @format uri */ deliveries_url?: string; /** @example web */ @@ -24280,13 +24744,13 @@ export interface components { secret?: string; }; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ created_at: string; type: string; @@ -24301,15 +24765,16 @@ export interface components { /** @description The API path's route template */ api_route?: string; /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count?: number; + /** @nullable */ last_rate_limited_timestamp?: string | null; last_request_timestamp?: string; }[]; @@ -24320,10 +24785,11 @@ export interface components { "api-insights-subject-stats": { subject_type?: string; subject_name?: string; - /** Format: int64 */ + /** @format int64 */ subject_id?: number; total_request_count?: number; rate_limited_request_count?: number; + /** @nullable */ last_rate_limited_timestamp?: string | null; last_request_timestamp?: string; }[]; @@ -24333,13 +24799,13 @@ export interface components { */ "api-insights-summary-stats": { /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count?: number; }; @@ -24349,9 +24815,9 @@ export interface components { */ "api-insights-time-stats": { timestamp?: string; - /** Format: int64 */ + /** @format int64 */ total_request_count?: number; - /** Format: int64 */ + /** @format int64 */ rate_limited_request_count?: number; }[]; /** @@ -24361,14 +24827,21 @@ export interface components { "api-insights-user-stats": { actor_type?: string; actor_name?: string; - /** Format: int64 */ + /** @format int64 */ actor_id?: number; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ integration_id?: number | null; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ oauth_application_id?: number | null; total_request_count?: number; rate_limited_request_count?: number; + /** @nullable */ last_rate_limited_timestamp?: string | null; last_request_timestamp?: string; }[]; @@ -24387,8 +24860,8 @@ export interface components { /** @example repository */ origin: string; /** - * Format: date-time * @example 2018-08-17T04:18:39Z + * @format date-time */ expires_at: string; }; @@ -24412,8 +24885,8 @@ export interface components { */ "org-membership": { /** - * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt + * @format uri */ url: string; /** @@ -24429,8 +24902,8 @@ export interface components { */ role: "admin" | "member" | "billing_manager"; /** - * Format: uri * @example https://api.github.com/orgs/octocat + * @format uri */ organization_url: string; organization: components["schemas"]["organization-simple"]; @@ -24445,8 +24918,8 @@ export interface components { */ migration: { /** - * Format: int64 * @example 79 + * @format int64 */ id: number; owner: components["schemas"]["nullable-simple-user"]; @@ -24465,22 +24938,22 @@ export interface components { /** @description The repositories included in the migration. Only returned for export migrations. */ repositories: components["schemas"]["repository"][]; /** - * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 + * @format uri */ url: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ updated_at: string; node_id: string; - /** Format: uri */ + /** @format uri */ archive_url?: string; /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; @@ -24491,20 +24964,25 @@ export interface components { */ "organization-role": { /** - * Format: int64 * @description The unique identifier of the role. + * @format int64 */ 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. */ + /** + * @nullable + * @description A short description about who this role is for or what permissions it grants. + */ description?: string | null; /** + * @nullable * @description The system role from which this role inherits permissions. * @enum {string|null} */ base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; /** + * @nullable * @description Source answers the question, "where did this role come from?" * @enum {string|null} */ @@ -24513,13 +24991,13 @@ export interface components { permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @description The date and time the role was created. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time the role was last updated. + * @format date-time */ updated_at: string; }; @@ -24538,6 +25016,7 @@ export interface components { node_id: string; name: string; slug: string; + /** @nullable */ description: string | null; privacy?: string; notification_setting?: string; @@ -24549,15 +25028,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; @@ -24574,9 +25053,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -24587,6 +25066,7 @@ export interface components { */ name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -24607,13 +25087,13 @@ export interface components { */ notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; /** @example justice-league */ @@ -24637,7 +25117,9 @@ export interface components { assignment?: "direct" | "indirect" | "mixed"; /** @description Team the user has gotten the role through */ inherited_from?: components["schemas"]["team-simple"][]; + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; @@ -24646,25 +25128,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -24674,25 +25159,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -24728,18 +25213,18 @@ export interface components { license?: string; description?: string; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ deleted_at?: string; /** Package Version Metadata */ @@ -24766,7 +25251,10 @@ export interface components { "organization-programmatic-access-grant-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */ id: number; - /** @description Reason for requesting access. */ + /** + * @nullable + * @description Reason for requesting access. + */ reason: string | null; owner: components["schemas"]["simple-user"]; /** @@ -24796,9 +25284,15 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** @@ -24836,9 +25330,15 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** @@ -24857,6 +25357,7 @@ export interface components { */ registry_type: "maven_repository"; /** + * @nullable * @description The username to use when authenticating with the private registry. * @example monalisa */ @@ -24866,9 +25367,9 @@ export interface components { * @enum {string} */ visibility: "all" | "private" | "selected"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24898,9 +25399,9 @@ export interface components { visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ selected_repository_ids?: number[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24909,23 +25410,23 @@ export interface components { */ project: { /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test + * @format uri */ owner_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604/columns + * @format uri */ columns_url: string; /** @example 1002604 */ @@ -24938,6 +25439,7 @@ export interface components { */ name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -24951,13 +25453,13 @@ export interface components { state: string; creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** @@ -24976,8 +25478,8 @@ export interface components { /** @description The name of the property */ property_name: string; /** - * Format: uri * @description The URL that can be used to fetch, update, or delete info about this property via the API. + * @format uri */ url?: string; /** @@ -24994,16 +25496,24 @@ export interface components { value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ default_value?: (string | string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; /** + * @nullable * @description Who can edit the values of the property * @example org_actors * @enum {string|null} @@ -25023,11 +25533,18 @@ export interface components { value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ default_value?: (string | string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ @@ -25040,7 +25557,10 @@ export interface components { "custom-property-value": { /** @description The name of the property */ property_name: string; - /** @description The value assigned to the property */ + /** + * @nullable + * @description The value assigned to the property + */ value: (string | string[]) | null; }; /** @@ -25059,13 +25579,14 @@ export interface components { }; /** * Repository + * @nullable * @description A repository on GitHub. */ "nullable-repository": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25093,16 +25614,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25124,28 +25648,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25167,13 +25691,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25187,30 +25711,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25218,25 +25742,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -25308,18 +25835,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -25420,8 +25950,8 @@ export interface components { */ "code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ url: string; /** @example citizen_code_of_conduct */ @@ -25429,8 +25959,9 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ html_url: string | null; }; @@ -25440,8 +25971,8 @@ export interface components { */ "full-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25453,16 +25984,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25484,28 +26018,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25527,13 +26061,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25547,30 +26081,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25578,25 +26112,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -25644,18 +26181,18 @@ export interface components { */ visibility?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string; permissions?: { @@ -25668,6 +26205,7 @@ export interface components { /** @example true */ allow_rebase_merge?: boolean; template_repository?: components["schemas"]["nullable-repository"]; + /** @nullable */ temp_clone_token?: string | null; /** @example true */ allow_squash_merge?: boolean; @@ -25757,7 +26295,10 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** + * @nullable + * @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -26238,16 +26779,18 @@ export interface components { /** @description The URL of the ruleset */ href?: string; }; + /** @nullable */ html?: { /** @description The html URL of the ruleset */ href?: string; } | null; }; + /** @nullable */ conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; rules?: components["schemas"]["repository-rule"][]; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }; /** @@ -26272,8 +26815,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string; /** @@ -26294,9 +26837,15 @@ export interface components { "rule-suite": { /** @description The unique identifier of the rule insight. */ id?: number; - /** @description The number that identifies the user. */ + /** + * @nullable + * @description The number that identifies the user. + */ actor_id?: number | null; - /** @description The handle for the GitHub user account. */ + /** + * @nullable + * @description The handle for the GitHub user account. + */ actor_name?: string | null; /** @description The first commit sha before the push evaluation. */ before_sha?: string; @@ -26309,8 +26858,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string; /** @@ -26319,6 +26868,7 @@ export interface components { */ result?: "pass" | "fail" | "bypass"; /** + * @nullable * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. * @enum {string|null} */ @@ -26328,9 +26878,15 @@ export interface components { rule_source?: { /** @description The type of rule source. */ type?: string; - /** @description The ID of the rule source. */ + /** + * @nullable + * @description The ID of the rule source. + */ id?: number | null; - /** @description The name of the rule source. */ + /** + * @nullable + * @description The name of the rule source. + */ name?: string | null; }; /** @@ -26345,23 +26901,41 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description The detailed failure message for the rule. Null if the rule passed. */ + /** + * @nullable + * @description The detailed failure message for the rule. Null if the rule passed. + */ details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions: string[] | null; }; /** @description A credit given to a user for a repository security advisory. */ @@ -26378,30 +26952,43 @@ export interface components { "repository-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id: string | null; /** - * Format: uri * @description The API URL for the advisory. + * @format uri */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** @description A short summary of the advisory. */ summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ description: string | null; /** + * @nullable * @description The severity of the advisory. * @enum {string|null} */ severity: "critical" | "high" | "medium" | "low" | null; - /** @description The author of the advisory. */ + /** + * @nullable + * @description The author of the advisory. + */ readonly author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ + /** + * @nullable + * @description The publisher of the advisory. + */ readonly publisher: components["schemas"]["simple-user"] | null; readonly identifiers: { /** @@ -26418,61 +27005,90 @@ export interface components { */ state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was created, in ISO 8601 format. + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was closed, in ISO 8601 format. + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; + /** @nullable */ readonly submission: { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; + /** @nullable */ vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + /** @nullable */ cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; + /** @nullable */ readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description A list of only the CWE IDs. */ + /** + * @nullable + * @description A list of only the CWE IDs. + */ cwe_ids: string[] | null; + /** @nullable */ credits: { /** @description The username of the user credited. */ login?: string; type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; + /** @nullable */ readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ + /** + * @nullable + * @description A list of users that collaborate on the advisory. + */ collaborating_users: components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ + /** + * @nullable + * @description A list of teams that collaborate on the advisory. + */ collaborating_teams: components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + /** + * @nullable + * @description A temporary private fork of the advisory's repository for collaborating on a fix. + */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; "actions-billing-usage": { @@ -26557,9 +27173,10 @@ export interface components { */ network_settings_ids?: string[]; /** - * Format: date-time + * @nullable * @description The time at which the network configuration was created, in ISO 8601 format. * @example 2024-04-26T11:31:07Z + * @format date-time */ created_on: string | null; }; @@ -26606,18 +27223,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -26630,25 +27247,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -26665,13 +27288,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** @example Organization */ @@ -26680,15 +27303,25 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; - /** @example 8 */ + /** + * @nullable + * @example 8 + */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -26698,10 +27331,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -26717,13 +27357,19 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ archived_at: string | null; }; /** @@ -26739,14 +27385,14 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** @@ -26756,7 +27402,10 @@ export interface components { name: string; /** @example justice-league */ slug: string; - /** @example A great team. */ + /** + * @nullable + * @example A great team. + */ description: string | null; /** * @description The level of privacy this team should have @@ -26778,8 +27427,8 @@ export interface components { /** @example https://api.github.com/organizations/1/team/1/members{/member} */ members_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; parent?: components["schemas"]["nullable-team-simple"]; @@ -26788,13 +27437,13 @@ export interface components { /** @example 10 */ repos_count: number; /** - * Format: date-time * @example 2017-07-14T16:53:42Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-08-17T12:37:15Z + * @format date-time */ updated_at: string; organization: components["schemas"]["team-organization"]; @@ -26825,20 +27474,23 @@ export interface components { /** @example 0 */ comments_count: number; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments + * @format uri */ comments_url: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ last_edited_at: string | null; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 + * @format uri */ html_url: string; /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ @@ -26859,8 +27511,8 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027 + * @format uri */ team_url: string; /** @@ -26869,13 +27521,13 @@ export interface components { */ title: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 + * @format uri */ url: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -26899,20 +27551,23 @@ export interface components { */ body_version: string; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ last_edited_at: string | null; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @format uri */ discussion_url: string; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @format uri */ html_url: string; /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ @@ -26923,13 +27578,13 @@ export interface components { */ number: number; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + * @format uri */ url: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -26951,8 +27606,8 @@ export interface components { */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** - * Format: date-time * @example 2016-05-20T20:09:31Z + * @format date-time */ created_at: string; }; @@ -26961,7 +27616,7 @@ export interface components { * @description Team Membership */ "team-membership": { - /** Format: uri */ + /** @format uri */ url: string; /** * @description The role of the user in the team. @@ -26988,6 +27643,7 @@ export interface components { id: number; node_id: string; name: string; + /** @nullable */ body: string | null; number: number; state: string; @@ -27041,16 +27697,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -27072,28 +27731,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -27115,13 +27774,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -27135,30 +27794,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -27166,25 +27825,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -27246,18 +27908,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -27315,29 +27980,32 @@ export interface components { */ "project-card": { /** - * Format: uri * @example https://api.github.com/projects/columns/cards/1478 + * @format uri */ url: string; /** - * Format: int64 * @description The project card's ID * @example 42 + * @format int64 */ id: number; /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ node_id: string; - /** @example Add payload for delete Project column */ + /** + * @nullable + * @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 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2016-09-05T14:20:22Z + * @format date-time */ updated_at: string; /** @@ -27348,18 +28016,18 @@ export interface components { column_name?: string; project_id?: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ column_url: string; /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 + * @format uri */ content_url?: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ project_url: string; }; @@ -27369,18 +28037,18 @@ export interface components { */ "project-column": { /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ project_url: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367/cards + * @format uri */ cards_url: string; /** @@ -27396,13 +28064,13 @@ export interface components { */ name: string; /** - * Format: date-time * @example 2016-09-05T14:18:44Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2016-09-05T14:22:28Z + * @format date-time */ updated_at: string; }; @@ -27466,12 +28134,22 @@ export interface components { archive_download_url: string; /** @description Whether or not the artifact has expired. */ expired: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; + /** @nullable */ workflow_run?: { /** @example 10 */ id?: number; @@ -27506,13 +28184,13 @@ export interface components { /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ version?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ last_accessed_at?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at?: string; /** @example 1024 */ @@ -27550,7 +28228,10 @@ export interface components { head_sha: string; /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ html_url: string | null; /** * @description The phase of the lifecycle that the job is currently in. @@ -27559,27 +28240,29 @@ export interface components { */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @description The outcome of the job. * @example success * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time * @description The time that the job created, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ started_at: string; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ completed_at: string | null; /** @@ -27596,6 +28279,7 @@ export interface components { */ status: "queued" | "in_progress" | "completed"; /** + * @nullable * @description The outcome of the job. * @example success */ @@ -27608,15 +28292,17 @@ export interface components { /** @example 1 */ number: number; /** - * Format: date-time + * @nullable * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ started_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ completed_at?: string | null; }[]; @@ -27632,31 +28318,37 @@ export interface components { */ labels: string[]; /** + * @nullable * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ runner_id: number | null; /** + * @nullable * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ runner_name: string | null; /** + * @nullable * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ runner_group_id: number | null; /** + * @nullable * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ runner_group_name: string | null; /** + * @nullable * @description The name of the workflow. * @example Build */ workflow_name: string | null; /** + * @nullable * @description The name of the current branch. * @example main */ @@ -27682,9 +28374,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** Actions Variable */ @@ -27700,15 +28392,15 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ updated_at: string; }; @@ -27740,7 +28432,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { - /** Format: int64 */ + /** @format int64 */ id: number; number: number; url: string; @@ -27748,7 +28440,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -27758,7 +28450,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -27767,6 +28459,7 @@ export interface components { }; /** * Simple Commit + * @nullable * @description A commit. */ "nullable-simple-commit": { @@ -27783,12 +28476,15 @@ export interface components { */ message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ author: { /** * @description Name of the commit's author @@ -27796,13 +28492,16 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ committer: { /** * @description Name of the commit's committer @@ -27810,9 +28509,9 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; @@ -27828,6 +28527,7 @@ export interface components { */ id: number; /** + * @nullable * @description The name of the workflow run. * @example Build */ @@ -27844,7 +28544,10 @@ export interface components { * @example MDEwOkNoZWNrU3VpdGU0Mg== */ check_suite_node_id?: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that points to the version of the workflow being run. @@ -27866,12 +28569,19 @@ export interface components { * @example 1 */ run_attempt?: number; + /** @nullable */ referenced_workflows?: components["schemas"]["referenced-workflow"][] | null; /** @example push */ event: string; - /** @example completed */ + /** + * @nullable + * @example completed + */ status: string | null; - /** @example neutral */ + /** + * @nullable + * @example neutral + */ conclusion: string | null; /** * @description The ID of the parent workflow. @@ -27885,17 +28595,20 @@ export interface components { url: string; /** @example https://github.com/github/hello-world/suites/4 */ html_url: string; - /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */ + /** + * @nullable + * @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. + */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; actor?: components["schemas"]["simple-user"]; triggering_actor?: components["schemas"]["simple-user"]; /** - * Format: date-time * @description The start time of the latest run. Resets on re-run. + * @format date-time */ run_started_at?: string; /** @@ -27929,6 +28642,7 @@ export interface components { */ rerun_url: string; /** + * @nullable * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ @@ -27973,15 +28687,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url?: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ created_at?: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ updated_at?: string; }[]; @@ -28028,9 +28742,9 @@ export interface components { "pending-deployment": { environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -28051,9 +28765,10 @@ export interface components { */ wait_timer: number; /** - * Format: date-time + * @nullable * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z + * @format date-time */ wait_timer_started_at: string | null; /** @@ -28073,14 +28788,14 @@ export interface components { */ deployment: { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ url: string; /** - * Format: int64 * @description Unique identifier of the deployment * @example 42 + * @format int64 */ id: number; /** @example MDEwOkRlcGxveW1lbnQx */ @@ -28107,27 +28822,30 @@ export interface components { * @example production */ environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** @@ -28194,13 +28912,13 @@ export interface components { */ state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ updated_at: string; /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ @@ -28210,8 +28928,8 @@ export interface components { /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ badge_url: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ deleted_at?: string; }; @@ -28257,9 +28975,9 @@ export interface components { */ ref: string; /** - * Format: date-time * @description The time when the activity occurred. * @example 2011-01-26T19:06:43Z + * @format date-time */ timestamp: string; /** @@ -28319,6 +29037,7 @@ export interface components { contexts: string[]; checks: { context: string; + /** @nullable */ app_id: number | null; }[]; contexts_url?: string; @@ -28330,8 +29049,8 @@ export interface components { */ "protected-branch-admin-enforced": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + * @format uri */ url: string; /** @example true */ @@ -28343,8 +29062,8 @@ export interface components { */ "protected-branch-pull-request-review": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + * @format uri */ url?: string; dismissal_restrictions?: { @@ -28388,17 +29107,17 @@ export interface components { * @description Branch Restriction Policy */ "branch-restriction-policy": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ apps_url: string; users: { login?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -28425,12 +29144,14 @@ export interface components { html_url?: string; name?: string; slug?: string; + /** @nullable */ description?: string | null; privacy?: string; notification_setting?: string; permission?: string; members_url?: string; repositories_url?: string; + /** @nullable */ parent?: string | null; }[]; apps: { @@ -28523,8 +29244,8 @@ export interface components { protection_url?: string; required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ url: string; /** @example true */ @@ -28549,16 +29270,17 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; protected: boolean; protection?: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url?: string; }; /** * Git User + * @nullable * @description Metaproperties for Git author/committer information. */ "nullable-git-user": { @@ -28573,8 +29295,11 @@ export interface components { verification: { verified: boolean; reason: string; + /** @nullable */ payload: string | null; + /** @nullable */ signature: string | null; + /** @nullable */ verified_at?: string | null; }; /** @@ -28598,18 +29323,18 @@ export interface components { /** @example 124 */ changes: number; /** - * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ blob_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ raw_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ contents_url: string; /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ @@ -28623,8 +29348,8 @@ export interface components { */ commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ url: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ @@ -28632,19 +29357,19 @@ export interface components { /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + * @format uri */ comments_url: string; commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ url: string; author: components["schemas"]["nullable-git-user"]; @@ -28657,26 +29382,28 @@ export interface components { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + * @format uri */ url: string; }; verification?: components["schemas"]["verification"]; }; + /** @nullable */ author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + /** @nullable */ committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ html_url?: string; }[]; @@ -28696,12 +29423,12 @@ export interface components { commit: components["schemas"]["commit"]; _links: { html: string; - /** Format: uri */ + /** @format uri */ self: string; }; protected: boolean; protection: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url: string; /** @example "mas*" */ pattern?: string; @@ -28714,8 +29441,8 @@ export interface components { */ "status-check-policy": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + * @format uri */ url: string; /** @example true */ @@ -28729,11 +29456,12 @@ export interface components { checks: { /** @example continuous-integration/travis-ci */ context: string; + /** @nullable */ app_id: number | null; }[]; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + * @format uri */ contexts_url: string; }; @@ -28742,11 +29470,11 @@ export interface components { * @description Branch protections protect branches */ "protected-branch": { - /** Format: uri */ + /** @format uri */ url: string; required_status_checks?: components["schemas"]["status-check-policy"]; required_pull_request_reviews?: { - /** Format: uri */ + /** @format uri */ url: string; dismiss_stale_reviews?: boolean; require_code_owner_reviews?: boolean; @@ -28757,11 +29485,11 @@ export interface components { */ require_last_push_approval: boolean; dismissal_restrictions?: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; users: components["schemas"]["simple-user"][]; teams: components["schemas"]["team"][]; @@ -28775,15 +29503,15 @@ export interface components { }; required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ url: string; /** @example true */ enabled: boolean; }; enforce_admins?: { - /** Format: uri */ + /** @format uri */ url: string; enabled: boolean; }; @@ -28820,8 +29548,8 @@ export interface components { */ "deployment-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ url: string; /** @@ -28843,26 +29571,29 @@ export interface components { * @example production */ environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ description: string | null; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** @@ -28883,9 +29614,9 @@ export interface components { */ "check-run": { /** - * Format: int64 * @description The id of the check. * @example 21 + * @format int64 */ id: number; /** @@ -28895,13 +29626,22 @@ export interface components { head_sha: string; /** @example MDg6Q2hlY2tSdW40 */ node_id: string; - /** @example 42 */ + /** + * @nullable + * @example 42 + */ external_id: string | null; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ html_url: string | null; - /** @example https://example.com */ + /** + * @nullable + * @example https://example.com + */ details_url: string | null; /** * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. @@ -28910,26 +29650,32 @@ export interface components { */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ started_at: string | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ completed_at: string | null; output: { + /** @nullable */ title: string | null; + /** @nullable */ summary: string | null; + /** @nullable */ text: string | null; annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; }; /** @@ -28937,6 +29683,7 @@ export interface components { * @example test-coverage */ name: string; + /** @nullable */ check_suite: { id: number; } | null; @@ -28956,17 +29703,35 @@ export interface components { start_line: number; /** @example 2 */ end_line: number; - /** @example 5 */ + /** + * @nullable + * @example 5 + */ start_column: number | null; - /** @example 10 */ + /** + * @nullable + * @example 10 + */ end_column: number | null; - /** @example warning */ + /** + * @nullable + * @example warning + */ annotation_level: string | null; - /** @example Spell Checker */ + /** + * @nullable + * @example Spell Checker + */ title: string | null; - /** @example Check your spelling for 'banaas'. */ + /** + * @nullable + * @example Check your spelling for 'banaas'. + */ message: string | null; - /** @example Do you mean 'bananas' or 'banana'? */ + /** + * @nullable + * @example Do you mean 'bananas' or 'banana'? + */ raw_details: string | null; blob_href: string; }; @@ -28988,12 +29753,15 @@ export interface components { */ message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ author: { /** * @description Name of the commit's author @@ -29001,13 +29769,16 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ committer: { /** * @description Name of the commit's committer @@ -29015,9 +29786,9 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; @@ -29028,13 +29799,16 @@ export interface components { */ "check-suite": { /** - * Format: int64 * @example 5 + * @format int64 */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that is being checked. @@ -29042,28 +29816,46 @@ export interface components { */ head_sha: string; /** + * @nullable * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; - /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ + /** + * @nullable + * @example https://api.github.com/repos/github/hello-world/check-suites/5 + */ url: string | null; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ before: string | null; - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ after: string | null; + /** @nullable */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; app: components["schemas"]["nullable-integration"]; repository: components["schemas"]["minimal-repository"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; head_commit: components["schemas"]["simple-commit"]; latest_check_runs_count: number; @@ -29102,16 +29894,21 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; "code-scanning-alert-rule": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -29120,11 +29917,20 @@ export interface components { description?: string; /** @description A description of the rule used to detect the alert. */ full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; }; "code-scanning-alert": { @@ -29154,11 +29960,14 @@ export interface components { * @enum {string} */ "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; - /** @description The description of an autofix. */ + /** + * @nullable + * @description The description of an autofix. + */ "code-scanning-autofix-description": string | null; /** - * Format: date-time * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-autofix-started-at": string; "code-scanning-autofix": { @@ -29166,7 +29975,10 @@ export interface components { description: components["schemas"]["code-scanning-autofix-description"]; started_at: components["schemas"]["code-scanning-autofix-started-at"]; }; - /** @description Commit an autofix for a code scanning alert */ + /** + * @nullable + * @description Commit an autofix for a code scanning alert + */ "code-scanning-autofix-commits": { /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ target_ref?: string; @@ -29184,18 +29996,21 @@ export interface components { * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ "code-scanning-analysis-sarif-id": string; - /** @description The SHA of the commit to which the analysis you are uploading relates. */ + /** + * @description The SHA of the commit to which the analysis you are uploading relates. + * @pattern ^[0-9a-fA-F]+$ + */ "code-scanning-analysis-commit-sha": string; /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ "code-scanning-analysis-environment": string; /** - * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-analysis-created-at": string; /** - * Format: uri * @description The REST API URL of the analysis resource. + * @format uri */ "code-scanning-analysis-url": string; "code-scanning-analysis": { @@ -29229,13 +30044,15 @@ export interface components { */ "code-scanning-analysis-deletion": { /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, without last analysis deletion confirmation + * @format uri */ readonly next_analysis_url: string | null; /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, with last analysis deletion confirmation + * @format uri */ readonly confirm_delete_url: string | null; }; @@ -29256,21 +30073,24 @@ export interface components { /** @description The size of the CodeQL database file in bytes. */ size: number; /** - * Format: date-time * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** - * Format: uri * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. + * @format uri */ url: string; - /** @description The commit SHA of the repository at the time the CodeQL database was created. */ + /** + * @nullable + * @description The commit SHA of the repository at the time the CodeQL database was created. + */ commit_oid?: string | null; }; /** @@ -29303,8 +30123,9 @@ export interface components { /** @example 80 */ stargazers_count: number; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; }; @@ -29335,18 +30156,19 @@ export interface components { /** @description The download url for the query pack. */ query_pack_url: string; /** - * Format: date-time * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at?: string; /** - * Format: date-time * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at?: string; /** - * Format: date-time + * @nullable * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + * @format date-time */ completed_at?: string | null; /** @enum {string} */ @@ -29410,11 +30232,13 @@ export interface components { /** @description Languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** + * @nullable * @description Runner type to be used. * @enum {string|null} */ runner_type?: "standard" | "labeled" | null; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29425,12 +30249,14 @@ export interface components { */ query_suite?: "default" | "extended"; /** - * Format: date-time + * @nullable * @description Timestamp of latest configuration update. * @example 2023-12-06T14:20:20.000Z + * @format date-time */ updated_at?: string | null; /** + * @nullable * @description The frequency of the periodic analysis. * @enum {string|null} */ @@ -29449,6 +30275,7 @@ export interface components { */ runner_type?: "standard" | "labeled"; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29475,6 +30302,7 @@ export interface components { * @description The full Git reference, formatted as `refs/heads/`, * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main + * @pattern ^refs/(heads|tags|pull)/.*$ */ "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)." */ @@ -29482,8 +30310,8 @@ export interface components { "code-scanning-sarifs-receipt": { id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** - * Format: uri * @description The REST API URL for checking the status of the upload. + * @format uri */ readonly url?: string; }; @@ -29494,11 +30322,15 @@ export interface components { */ processing_status?: "pending" | "complete" | "failed"; /** - * Format: uri + * @nullable * @description The REST API URL for getting the analyses associated with the upload. + * @format uri */ readonly analyses_url?: string | null; - /** @description Any errors that ocurred during processing of the delivery. */ + /** + * @nullable + * @description Any errors that ocurred during processing of the delivery. + */ readonly errors?: string[] | null; }; /** @description Code security configuration associated with a repository and attachment status */ @@ -29537,6 +30369,7 @@ export interface components { */ kind: string; /** + * @nullable * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. * @example The pattern `/` will never match anything, did you mean `*` instead? */ @@ -29592,6 +30425,7 @@ export interface components { */ cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -29619,9 +30453,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -29632,34 +30466,39 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29669,25 +30508,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -29711,9 +30550,9 @@ export interface components { */ "repository-invitation": { /** - * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 + * @format int64 */ id: number; repository: components["schemas"]["minimal-repository"]; @@ -29726,8 +30565,8 @@ export interface components { */ permissions: "read" | "write" | "admin" | "triage" | "maintain"; /** - * Format: date-time * @example 2016-06-13T14:52:50-05:00 + * @format date-time */ created_at: string; /** @description Whether or not the invitation has expired */ @@ -29743,40 +30582,46 @@ export interface components { }; /** * Collaborator + * @nullable * @description Collaborator */ "nullable-collaborator": { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29786,25 +30631,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -29837,21 +30682,24 @@ export interface components { * @description Commit Comment */ "commit-comment": { - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ url: string; id: number; node_id: string; body: string; + /** @nullable */ path: string | null; + /** @nullable */ position: number | null; + /** @nullable */ line: number | null; commit_id: string; user: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -29877,6 +30725,7 @@ export interface components { }; /** * Auto merge + * @nullable * @description The status of auto merging a pull request. */ "auto-merge": { @@ -29897,57 +30746,57 @@ export interface components { */ "pull-request-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ statuses_url: string; /** @example 1347 */ @@ -29959,10 +30808,13 @@ export interface components { /** @example new-feature */ title: string; user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; @@ -29972,33 +30824,44 @@ export interface components { default: boolean; }[]; milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ merge_commit_sha: string | null; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_reviewers?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_teams?: components["schemas"]["team"][] | null; head: { label: string; @@ -30034,21 +30897,29 @@ export interface components { }; /** Simple Commit Status */ "simple-commit-status": { + /** @nullable */ description: string | null; id: number; node_id: string; state: string; context: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ target_url: string | null; + /** @nullable */ required?: boolean | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ avatar_url: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30061,9 +30932,9 @@ export interface components { sha: string; total_count: number; repository: components["schemas"]["minimal-repository"]; - /** Format: uri */ + /** @format uri */ commit_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -30072,11 +30943,14 @@ export interface components { */ status: { url: string; + /** @nullable */ avatar_url: string | null; id: number; node_id: string; state: string; + /** @nullable */ description: string | null; + /** @nullable */ target_url: string | null; context: string; created_at: string; @@ -30085,12 +30959,13 @@ export interface components { }; /** * Code Of Conduct Simple + * @nullable * @description Code of Conduct Simple */ "nullable-code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ url: string; /** @example citizen_code_of_conduct */ @@ -30098,16 +30973,20 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ html_url: string | null; } | null; - /** Community Health File */ + /** + * Community Health File + * @nullable + */ "nullable-community-health-file": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; } | null; /** @@ -30117,9 +30996,15 @@ export interface components { "community-profile": { /** @example 100 */ health_percentage: number; - /** @example My first repository on GitHub! */ + /** + * @nullable + * @example My first repository on GitHub! + */ description: string | null; - /** @example example.com */ + /** + * @nullable + * @example example.com + */ documentation: string | null; files: { code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; @@ -30131,8 +31016,9 @@ export interface components { pull_request_template: components["schemas"]["nullable-community-health-file"]; }; /** - * Format: date-time + * @nullable * @example 2017-02-28T19:09:29Z + * @format date-time */ updated_at: string | null; /** @example true */ @@ -30144,28 +31030,28 @@ export interface components { */ "commit-comparison": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + * @format uri */ permalink_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch + * @format uri */ patch_url: string; base_commit: components["schemas"]["commit"]; @@ -30195,13 +31081,22 @@ export interface components { path: string; sha: string; content?: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; entries?: { type: string; @@ -30209,29 +31104,50 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30247,20 +31163,35 @@ export interface components { path: string; content?: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; @@ -30280,20 +31211,35 @@ export interface components { path: string; content: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; /** @example "actual/actual.md" */ @@ -30316,20 +31262,35 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30343,26 +31304,41 @@ export interface components { * @enum {string} */ type: "submodule"; - /** Format: uri */ + /** @format uri */ submodule_git_url: string; size: number; name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30371,6 +31347,7 @@ export interface components { * @description File Commit */ "file-commit": { + /** @nullable */ content: { name?: string; path?: string; @@ -30415,8 +31392,11 @@ export interface components { verification?: { verified?: boolean; reason?: string; + /** @nullable */ signature?: string | null; + /** @nullable */ payload?: string | null; + /** @nullable */ verified_at?: string | null; }; }; @@ -30445,26 +31425,27 @@ export interface components { login?: string; id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ avatar_url?: string; + /** @nullable */ gravatar_id?: string | null; - /** Format: uri */ + /** @format uri */ url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; following_url?: string; gists_url?: string; starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; events_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; type: string; site_admin?: boolean; @@ -30487,6 +31468,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -30501,11 +31483,15 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; @@ -30520,9 +31506,9 @@ export interface components { * @example MY_ARTIFACTORY_PASSWORD */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30540,11 +31526,20 @@ export interface components { name: string; /** @example 1.0.0 */ version: string; - /** @example pkg:/npm/%40actions/core@1.1.0 */ + /** + * @nullable + * @example pkg:/npm/%40actions/core@1.1.0 + */ package_url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ license: string | null; - /** @example https://github.com/github/actions */ + /** + * @nullable + * @example https://github.com/github/actions + */ source_repository_url: string | null; vulnerabilities: { /** @example critical */ @@ -30699,6 +31694,7 @@ export interface components { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. * @example pkg:/npm/%40actions/http-client@1.0.11 + * @pattern ^pkg */ package_url?: string; metadata?: components["schemas"]["metadata"]; @@ -30771,6 +31767,7 @@ export interface components { /** * @description The repository branch that triggered this snapshot. * @example refs/heads/main + * @pattern ^refs/ */ ref: string; /** @description A description of the detector used. */ @@ -30797,9 +31794,9 @@ export interface components { [key: string]: components["schemas"]["manifest"]; }; /** - * Format: date-time * @description The time at which the snapshot was scanned. * @example 2020-06-13T14:52:50-05:00 + * @format date-time */ scanned: string; }; @@ -30809,13 +31806,13 @@ export interface components { */ "deployment-status": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ @@ -30840,44 +31837,44 @@ export interface components { */ environment: string; /** - * Format: uri * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ target_url: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 + * @format uri */ deployment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** - * Format: uri * @description The URL for accessing your environment. * @default * @example https://staging.example.com/ + * @format uri */ environment_url: string; /** - * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -30887,7 +31884,10 @@ export interface components { * @example 30 */ "wait-timer": number; - /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ + /** + * @nullable + * @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. + */ "deployment-branch-policy-settings": { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ protected_branches: boolean; @@ -30900,9 +31900,9 @@ export interface components { */ environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ id: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -30917,15 +31917,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ updated_at: string; /** @description Built-in deployment protection rules for the environment. */ @@ -31084,9 +32084,10 @@ export interface components { blob: { content: string; encoding: string; - /** Format: uri */ + /** @format uri */ url: string; sha: string; + /** @nullable */ size: number | null; node_id: string; highlighted_content?: string; @@ -31102,14 +32103,14 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -31126,9 +32127,9 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -31153,7 +32154,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -31162,19 +32163,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { verified: boolean; reason: string; + /** @nullable */ signature: string | null; + /** @nullable */ payload: string | null; + /** @nullable */ verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -31184,7 +32188,7 @@ export interface components { "git-ref": { ref: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; object: { type: string; @@ -31193,7 +32197,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; }; @@ -31212,9 +32216,9 @@ export interface components { /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ sha: string; /** - * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + * @format uri */ url: string; /** @@ -31230,7 +32234,7 @@ export interface components { object: { sha: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; }; verification?: components["schemas"]["verification"]; @@ -31241,7 +32245,7 @@ export interface components { */ "git-tree": { sha: string; - /** Format: uri */ + /** @format uri */ url: string; truncated: boolean; /** @@ -31302,8 +32306,11 @@ export interface components { }; /** Hook Response */ "hook-response": { + /** @nullable */ code: number | null; + /** @nullable */ status: string | null; + /** @nullable */ message: string | null; }; /** @@ -31337,33 +32344,33 @@ export interface components { events: string[]; config: components["schemas"]["webhook-config"]; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test + * @format uri */ test_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + * @format uri */ ping_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries + * @format uri */ deliveries_url?: string; last_response: components["schemas"]["hook-response"]; @@ -31373,6 +32380,7 @@ export interface components { * @description A repository import from an external source. */ import: { + /** @nullable */ vcs: string | null; use_lfs?: boolean; /** @description The URL of the originating repository. */ @@ -31381,11 +32389,17 @@ export interface components { tfvc_project?: string; /** @enum {string} */ status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; + /** @nullable */ status_text?: string | null; + /** @nullable */ failed_step?: string | null; + /** @nullable */ error_message?: string | null; + /** @nullable */ import_percent?: number | null; + /** @nullable */ commit_count?: number | null; + /** @nullable */ push_percent?: number | null; has_large_files?: boolean; large_files_size?: number; @@ -31396,14 +32410,15 @@ export interface components { human_name?: string; }[]; message?: string; + /** @nullable */ authors_count?: number | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ authors_url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; svn_root?: string; }; @@ -31417,9 +32432,9 @@ export interface components { remote_name: string; email: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ import_url: string; }; /** @@ -31434,26 +32449,27 @@ export interface components { }; /** * Issue + * @nullable * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ "nullable-issue": { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -31466,6 +32482,7 @@ export interface components { */ state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -31477,6 +32494,7 @@ export interface components { */ title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -31490,45 +32508,67 @@ export interface components { * ] */ labels: (string | { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ url?: string; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; default?: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; comments: number; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; draft?: boolean; closed_by?: components["schemas"]["nullable-simple-user"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -31541,14 +32581,18 @@ export interface components { * @description Issue Event Label */ "issue-event-label": { + /** @nullable */ name: string | null; + /** @nullable */ color: string | null; }; /** Issue Event Dismissed Review */ "issue-event-dismissed-review": { state: string; review_id: number; + /** @nullable */ dismissal_message: string | null; + /** @nullable */ dismissal_commit_id?: string | null; }; /** @@ -31563,10 +32607,10 @@ export interface components { * @description Issue Event Project Card */ "issue-event-project-card": { - /** Format: uri */ + /** @format uri */ url: string; id: number; - /** Format: uri */ + /** @format uri */ project_url: string; project_id: number; column_name: string; @@ -31586,27 +32630,33 @@ export interface components { */ "issue-event": { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDEwOklzc3VlRXZlbnQx */ node_id: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 + * @format uri */ url: string; actor: components["schemas"]["nullable-simple-user"]; /** @example closed */ event: string; - /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e + */ commit_id: string | null; - /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ commit_url: string | null; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; issue?: components["schemas"]["nullable-issue"]; @@ -31621,6 +32671,7 @@ export interface components { project_card?: components["schemas"]["issue-event-project-card"]; rename?: components["schemas"]["issue-event-rename"]; author_association?: components["schemas"]["author-association"]; + /** @nullable */ lock_reason?: string | null; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; @@ -31634,7 +32685,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31653,7 +32706,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31672,7 +32727,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["integration"]; @@ -31689,7 +32746,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31706,7 +32765,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31724,7 +32785,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31742,7 +32805,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31761,7 +32826,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31779,7 +32846,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31797,13 +32866,16 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; dismissed_review: { state: string; review_id: number; + /** @nullable */ dismissal_message: string | null; dismissal_commit_id?: string; }; @@ -31818,11 +32890,16 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; - /** @example "off-topic" */ + /** + * @nullable + * @example "off-topic" + */ lock_reason: string | null; }; /** @@ -31835,16 +32912,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31860,16 +32939,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31885,16 +32966,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31910,16 +32993,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31936,17 +33021,17 @@ export interface components { */ label: { /** - * Format: int64 * @description Unique identifier for the label. * @example 208045946 + * @format int64 */ id: number; /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ node_id: string; /** - * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug + * @format uri */ url: string; /** @@ -31955,6 +33040,7 @@ export interface components { */ name: string; /** + * @nullable * @description Optional description of the label, such as its purpose. * @example Something isn't working */ @@ -31984,9 +33070,9 @@ export interface components { id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ url: string; /** @@ -31996,20 +33082,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -32022,9 +33108,9 @@ export interface components { "timeline-cross-referenced-event": { event: string; actor?: components["schemas"]["simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; source: { type?: string; @@ -32043,14 +33129,14 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -32067,9 +33153,9 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -32094,7 +33180,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -32103,19 +33189,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { verified: boolean; reason: string; + /** @nullable */ signature: string | null; + /** @nullable */ payload: string | null; + /** @nullable */ verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -32133,6 +33222,7 @@ export interface components { node_id: string; user: components["schemas"]["simple-user"]; /** + * @nullable * @description The text of the review. * @example This looks great. */ @@ -32140,13 +33230,13 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ pull_request_url: string; _links: { @@ -32157,7 +33247,7 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** * @description A commit SHA for the review. @@ -32179,15 +33269,16 @@ export interface components { */ url: string; /** - * Format: int64 + * @nullable * @description The ID of the pull request review to which the comment belongs. * @example 42 + * @format int64 */ pull_request_review_id: number | null; /** - * Format: int64 * @description The ID of the pull request review comment. * @example 1 + * @format int64 */ id: number; /** @@ -32237,62 +33328,65 @@ export interface components { */ body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; /** - * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ html_url: string; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ pull_request_url: string; author_association: components["schemas"]["author-association"]; _links: { self: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ href: string; }; html: { /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ href: string; }; pull_request: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ href: string; }; }; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ start_line?: number | null; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ original_start_line?: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -32354,7 +33448,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32370,7 +33466,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32386,10 +33484,13 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; + /** @nullable */ state_reason?: string | null; }; /** @@ -32409,7 +33510,9 @@ export interface components { verified: boolean; created_at: string; read_only: boolean; + /** @nullable */ added_by?: string | null; + /** @nullable */ last_used?: string | null; enabled?: boolean; }; @@ -32429,23 +33532,38 @@ export interface components { path: string; sha: string; size: number; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; type: string; content: string; encoding: string; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; license: components["schemas"]["nullable-license-simple"]; @@ -32466,18 +33584,18 @@ export interface components { */ milestone: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ labels_url: string; /** @example 1002604 */ @@ -32501,7 +33619,10 @@ export interface components { * @example v1.0 */ title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -32509,23 +33630,25 @@ export interface components { /** @example 8 */ closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ due_on: string | null; }; @@ -32551,7 +33674,7 @@ export interface components { * ] */ domains: string[]; - /** Format: date */ + /** @format date */ expires_at?: string; }; /** @@ -32560,31 +33683,35 @@ export interface components { */ page: { /** - * Format: uri * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages + * @format uri */ url: string; /** + * @nullable * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ status: "built" | "building" | "errored" | null; /** + * @nullable * @description The Pages site's custom domain * @example example.com */ cname: string | null; /** + * @nullable * @description The state if the domain is verified * @example pending * @enum {string|null} */ protected_domain_state?: "pending" | "verified" | "unverified" | null; /** - * Format: date-time + * @nullable * @description The timestamp when a pending domain becomes unverified. + * @format date-time */ pending_domain_unverified_at?: string | null; /** @@ -32594,12 +33721,13 @@ export interface components { */ custom_404: boolean; /** - * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com + * @format uri */ html_url?: string; /** + * @nullable * @description The process in which the Page will be built. * @example legacy * @enum {string|null} @@ -32623,18 +33751,19 @@ export interface components { * @description Page Build */ "page-build": { - /** Format: uri */ + /** @format uri */ url: string; status: string; error: { + /** @nullable */ message: string | null; }; pusher: components["schemas"]["nullable-simple-user"]; commit: string; duration: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -32643,8 +33772,8 @@ export interface components { */ "page-build-status": { /** - * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest + * @format uri */ url: string; /** @example queued */ @@ -32658,21 +33787,21 @@ export interface components { /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ id: number | string; /** - * Format: uri * @description The URI to monitor GitHub Pages deployment status. * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 + * @format uri */ status_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages. * @example hello-world.github.io + * @format uri */ page_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages preview. * @example monalisa-1231a2312sa32-23sda74.drafts.github.io + * @format uri */ preview_url?: string; }; @@ -32694,59 +33823,96 @@ export interface components { uri?: string; nameservers?: string; dns_resolves?: boolean; + /** @nullable */ is_proxied?: boolean | null; + /** @nullable */ is_cloudflare_ip?: boolean | null; + /** @nullable */ is_fastly_ip?: boolean | null; + /** @nullable */ is_old_ip_address?: boolean | null; + /** @nullable */ is_a_record?: boolean | null; + /** @nullable */ has_cname_record?: boolean | null; + /** @nullable */ has_mx_records_present?: boolean | null; is_valid_domain?: boolean; is_apex_domain?: boolean; + /** @nullable */ should_be_a_record?: boolean | null; + /** @nullable */ is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ is_cname_to_fastly?: boolean | null; + /** @nullable */ is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ is_non_github_pages_ip_present?: boolean | null; is_pages_domain?: boolean; + /** @nullable */ is_served_by_pages?: boolean | null; is_valid?: boolean; + /** @nullable */ reason?: string | null; responds_to_https?: boolean; enforces_https?: boolean; + /** @nullable */ https_error?: string | null; + /** @nullable */ is_https_eligible?: boolean | null; + /** @nullable */ caa_error?: string | null; }; + /** @nullable */ alt_domain?: { host?: string; uri?: string; nameservers?: string; dns_resolves?: boolean; + /** @nullable */ is_proxied?: boolean | null; + /** @nullable */ is_cloudflare_ip?: boolean | null; + /** @nullable */ is_fastly_ip?: boolean | null; + /** @nullable */ is_old_ip_address?: boolean | null; + /** @nullable */ is_a_record?: boolean | null; + /** @nullable */ has_cname_record?: boolean | null; + /** @nullable */ has_mx_records_present?: boolean | null; is_valid_domain?: boolean; is_apex_domain?: boolean; + /** @nullable */ should_be_a_record?: boolean | null; + /** @nullable */ is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ is_cname_to_fastly?: boolean | null; + /** @nullable */ is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ is_non_github_pages_ip_present?: boolean | null; is_pages_domain?: boolean; + /** @nullable */ is_served_by_pages?: boolean | null; is_valid?: boolean; + /** @nullable */ reason?: string | null; responds_to_https?: boolean; enforces_https?: boolean; + /** @nullable */ https_error?: string | null; + /** @nullable */ is_https_eligible?: boolean | null; + /** @nullable */ caa_error?: string | null; } | null; }; @@ -32756,57 +33922,57 @@ export interface components { */ "pull-request": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ statuses_url: string; /** @@ -32828,46 +33994,61 @@ export interface components { */ title: string; user: components["schemas"]["simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; name: string; + /** @nullable */ description: string | null; color: string; default: boolean; }[]; milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ merge_commit_sha: string | null; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_reviewers?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_teams?: components["schemas"]["team-simple"][] | null; head: { label: string; @@ -32901,9 +34082,15 @@ export interface components { */ draft?: boolean; merged: boolean; - /** @example true */ + /** + * @nullable + * @example true + */ mergeable: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ rebaseable?: boolean | null; /** @example clean */ mergeable_state: string; @@ -32949,9 +34136,9 @@ export interface components { */ "pull-request-review": { /** - * Format: int64 * @description Unique identifier of the review * @example 42 + * @format int64 */ id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ @@ -32965,13 +34152,13 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ pull_request_url: string; _links: { @@ -32982,9 +34169,10 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** + * @nullable * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ @@ -32999,18 +34187,19 @@ export interface components { */ "review-comment": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ url: string; /** - * Format: int64 + * @nullable * @example 42 + * @format int64 */ pull_request_review_id: number | null; /** - * Format: int64 * @example 10 + * @format int64 */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ @@ -33019,7 +34208,10 @@ export interface components { diff_hunk: string; /** @example file1.txt */ path: string; - /** @example 1 */ + /** + * @nullable + * @example 1 + */ position: number | null; /** @example 4 */ original_position: number; @@ -33033,23 +34225,23 @@ export interface components { /** @example Great stuff */ body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ pull_request_url: string; author_association: components["schemas"]["author-association"]; @@ -33068,6 +34260,7 @@ export interface components { */ side: "LEFT" | "RIGHT"; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -33084,11 +34277,13 @@ export interface components { */ original_line?: number; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ start_line?: number | null; /** + * @nullable * @description The original first line of the range for a multi-line comment. * @example 2 */ @@ -33099,9 +34294,9 @@ export interface components { * @description Data related to a release. */ "release-asset": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ browser_download_url: string; id: number; node_id: string; @@ -33110,6 +34305,7 @@ export interface components { * @example Team Environment */ name: string; + /** @nullable */ label: string | null; /** * @description State of the release asset. @@ -33119,9 +34315,9 @@ export interface components { content_type: string; size: number; download_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; uploader: components["schemas"]["nullable-simple-user"]; }; @@ -33130,16 +34326,22 @@ export interface components { * @description A release. */ release: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ assets_url: string; upload_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; id: number; node_id: string; @@ -33153,7 +34355,9 @@ export interface components { * @example master */ target_commitish: string; + /** @nullable */ name: string | null; + /** @nullable */ body?: string | null; /** * @description true to create a draft (unpublished) release, false to create a published one. @@ -33165,9 +34369,12 @@ export interface components { * @example false */ prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; author: components["schemas"]["simple-user"]; assets: components["schemas"]["release-asset"][]; @@ -33175,8 +34382,8 @@ export interface components { body_text?: string; mentions_count?: number; /** - * Format: uri * @description The URL of the release discussion. + * @format uri */ discussion_url?: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -33221,19 +34428,23 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; @@ -33244,22 +34455,33 @@ export interface components { secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; /** @@ -33267,12 +34489,21 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. + */ multi_repo?: boolean | null; }; - /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ + /** + * @nullable + * @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; /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ "secret-scanning-location-commit": { @@ -33343,99 +34574,99 @@ export interface components { /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_title_url: string; }; /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ "secret-scanning-location-issue-body": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_body_url: string; }; /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ "secret-scanning-location-issue-comment": { /** - * Format: uri * @description The API URL to get the issue comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ issue_comment_url: string; }; /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ "secret-scanning-location-discussion-title": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082 + * @format uri */ discussion_title_url: string; }; /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ "secret-scanning-location-discussion-body": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussion-4566270 + * @format uri */ discussion_body_url: string; }; /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ "secret-scanning-location-discussion-comment": { /** - * Format: uri * @description The API URL to get the discussion comment where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + * @format uri */ discussion_comment_url: string; }; /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ "secret-scanning-location-pull-request-title": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ pull_request_title_url: string; }; /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ "secret-scanning-location-pull-request-body": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ pull_request_body_url: string; }; /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ "secret-scanning-location-pull-request-comment": { /** - * Format: uri * @description The API URL to get the pull request comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ pull_request_comment_url: string; }; /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ "secret-scanning-location-pull-request-review": { /** - * Format: uri * @description The API URL to get the pull request review where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + * @format uri */ pull_request_review_url: string; }; /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ "secret-scanning-location-pull-request-review-comment": { /** - * Format: uri * @description The API URL to get the pull request review comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + * @format uri */ pull_request_review_comment_url: string; }; @@ -33456,8 +34687,9 @@ export interface components { "secret-scanning-push-protection-bypass": { reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** - * Format: date-time + * @nullable * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ expire_at?: string | null; /** @description The token type this bypass is for. */ @@ -33470,13 +34702,15 @@ export interface components { /** @description The state of the scan. Either "completed", "running", or "pending" */ status?: string; /** - * Format: date-time + * @nullable * @description The time that the scan was completed. Empty if the scan is running + * @format date-time */ completed_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the scan was started. Empty if the scan is pending + * @format date-time */ started_at?: string | null; }; @@ -33496,37 +34730,62 @@ export interface components { summary: string; /** @description A detailed description of what the advisory impacts. */ description: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ vulnerabilities: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ credits?: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33539,29 +34798,51 @@ export interface components { summary: string; /** @description A detailed description of what the advisory impacts. */ description: string; - /** @description An array of products affected by the vulnerability detailed in a repository security advisory. */ + /** + * @nullable + * @description An array of products affected by the vulnerability detailed in a repository security advisory. + */ vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[] | null; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33574,46 +34855,77 @@ export interface components { summary?: string; /** @description A detailed description of what the advisory impacts. */ description?: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ credits?: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description The state of the advisory. * @enum {string} */ state?: "published" | "closed" | "draft"; - /** @description A list of usernames who have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of usernames who have been granted write access to the advisory. + */ collaborating_users?: string[] | null; - /** @description A list of team slugs which have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of team slugs which have been granted write access to the advisory. + */ collaborating_teams?: string[] | null; }; /** @@ -33621,7 +34933,7 @@ export interface components { * @description Stargazer */ stargazer: { - /** Format: date-time */ + /** @format date-time */ starred_at: string; user: components["schemas"]["nullable-simple-user"]; }; @@ -33694,20 +35006,21 @@ export interface components { subscribed: boolean; /** @description Determines if all notifications should be blocked from this repository. */ ignored: boolean; + /** @nullable */ reason: string | null; /** - * Format: date-time * @example 2012-10-06T21:34:12Z + * @format date-time */ created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/subscription + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; }; @@ -33720,17 +35033,17 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** - * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 + * @format uri */ zipball_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 + * @format uri */ tarball_url: string; node_id: string; @@ -33760,7 +35073,7 @@ export interface components { }; /** Traffic */ traffic: { - /** Format: date-time */ + /** @format date-time */ timestamp: string; uniques: number; count: number; @@ -33816,6 +35129,7 @@ export interface components { /** Search Result Text Matches */ "search-result-text-matches": { object_url?: string; + /** @nullable */ object_type?: string | null; property?: string; fragment?: string; @@ -33832,17 +35146,18 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; repository: components["schemas"]["minimal-repository"]; score: number; file_size?: number; + /** @nullable */ language?: string | null; - /** Format: date-time */ + /** @format date-time */ last_modified_at?: string; /** * @example [ @@ -33858,18 +35173,18 @@ export interface components { * @description Commit Search Result Item */ "commit-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { name: string; email: string; - /** Format: date-time */ + /** @format date-time */ date: string; }; committer: components["schemas"]["nullable-git-user"]; @@ -33877,10 +35192,10 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification?: components["schemas"]["verification"]; }; @@ -33901,34 +35216,37 @@ export interface components { * @description Issue Search Result Item */ "issue-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; number: number; title: string; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; user: components["schemas"]["nullable-simple-user"]; labels: { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; url?: string; name?: string; color?: string; default?: boolean; + /** @nullable */ description?: string | null; }[]; /** Sub-issues Summary */ @@ -33938,27 +35256,46 @@ export interface components { percent_completed: number; }; state: string; + /** @nullable */ state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; milestone: components["schemas"]["nullable-milestone"]; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; body?: string; @@ -33968,7 +35305,7 @@ export interface components { repository?: components["schemas"]["repository"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -33980,11 +35317,12 @@ export interface components { "label-search-result-item": { id: number; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; name: string; color: string; default: boolean; + /** @nullable */ description: string | null; score: number; text_matches?: components["schemas"]["search-result-text-matches"]; @@ -34000,58 +35338,63 @@ export interface components { full_name: string; owner: components["schemas"]["nullable-simple-user"]; private: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; + /** @nullable */ description: string | null; fork: boolean; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ pushed_at: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ homepage: string | null; size: number; stargazers_count: number; watchers_count: number; + /** @nullable */ language: string | null; forks_count: number; open_issues_count: number; master_branch?: string; default_branch: string; score: number; - /** Format: uri */ + /** @format uri */ forks_url: string; keys_url: string; collaborators_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; issue_events_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; assignees_url: string; branches_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; blobs_url: string; git_tags_url: string; git_refs_url: string; trees_url: string; statuses_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; commits_url: string; git_commits_url: string; @@ -34059,10 +35402,10 @@ export interface components { issue_comment_url: string; contents_url: string; compare_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; archive_url: string; - /** Format: uri */ + /** @format uri */ downloads_url: string; issues_url: string; pulls_url: string; @@ -34070,18 +35413,21 @@ export interface components { notifications_url: string; labels_url: string; releases_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; git_url: string; ssh_url: string; clone_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; forks: number; open_issues: number; watchers: number; topics?: string[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; has_issues: boolean; has_projects: boolean; @@ -34120,22 +35466,32 @@ export interface components { */ "topic-search-result-item": { name: string; + /** @nullable */ display_name: string | null; + /** @nullable */ short_description: string | null; + /** @nullable */ description: string | null; + /** @nullable */ created_by: string | null; + /** @nullable */ released: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; featured: boolean; curated: boolean; score: number; + /** @nullable */ repository_count?: number | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ logo_url?: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ related?: { topic_relation?: { id?: number; @@ -34144,6 +35500,7 @@ export interface components { relation_type?: string; }; }[] | null; + /** @nullable */ aliases?: { topic_relation?: { id?: number; @@ -34159,25 +35516,26 @@ export interface components { */ "user-search-result-item": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; score: number; @@ -34189,21 +35547,33 @@ export interface components { public_gists?: number; followers?: number; following?: number; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; + /** @nullable */ name?: string | null; + /** @nullable */ bio?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; + /** @nullable */ location?: string | null; site_admin: boolean; + /** @nullable */ hireable?: boolean | null; text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ blog?: string | null; + /** @nullable */ company?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at?: string | null; user_view_type?: string; }; @@ -34215,8 +35585,8 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -34227,25 +35597,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -34255,52 +35628,73 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ type: string; site_admin: boolean; - /** @example monalisa octocat */ + /** + * @nullable + * @example monalisa octocat + */ name: string | null; - /** @example GitHub */ + /** + * @nullable + * @example GitHub + */ company: string | null; - /** @example https://github.com/blog */ + /** + * @nullable + * @example https://github.com/blog + */ blog: string | null; - /** @example San Francisco */ + /** + * @nullable + * @example San Francisco + */ location: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ email: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ notification_email?: string | null; + /** @nullable */ hireable: boolean | null; - /** @example There once was... */ + /** + * @nullable + * @example There once was... + */ bio: string | null; - /** @example monalisa */ + /** + * @nullable + * @example monalisa + */ twitter_username?: string | null; /** @example 2 */ public_repos: number; @@ -34311,13 +35705,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ updated_at: string; /** @example 81 */ @@ -34352,13 +35746,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -34367,9 +35761,9 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/user/secrets/SECRET_NAME/repositories + * @format uri */ selected_repositories_url: string; }; @@ -34395,22 +35789,26 @@ export interface components { */ "codespace-export-details": { /** + * @nullable * @description State of the latest export * @example succeeded | failed | in_progress */ state?: string | null; /** - * Format: date-time + * @nullable * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z + * @format date-time */ completed_at?: string | null; /** + * @nullable * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ branch?: string | null; /** + * @nullable * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ @@ -34426,6 +35824,7 @@ export interface components { */ export_url?: string; /** + * @nullable * @description Web url for the exported branch * @example https://github.com/octocat/hello-world/tree/:branch */ @@ -34437,8 +35836,8 @@ export interface components { */ "codespace-with-full-repository": { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -34447,11 +35846,13 @@ export interface components { */ name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -34461,29 +35862,31 @@ export interface components { repository: components["schemas"]["full-repository"]; machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ last_used_at: string; /** @@ -34493,8 +35896,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -34526,60 +35929,77 @@ export interface components { */ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ allowed_port_privacy_settings?: string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ retention_expires_at?: string | null; }; @@ -34589,15 +36009,18 @@ export interface components { */ email: { /** - * Format: email * @example octocat@github.com + * @format email */ email: string; /** @example true */ primary: boolean; /** @example true */ verified: boolean; - /** @example public */ + /** + * @nullable + * @example public + */ visibility: string | null; }; /** @@ -34606,12 +36029,16 @@ export interface components { */ "gpg-key": { /** - * Format: int64 * @example 3 + * @format int64 */ id: number; - /** @example Octocat's GPG Key */ + /** + * @nullable + * @example Octocat's GPG Key + */ name?: string | null; + /** @nullable */ primary_key_id: number | null; /** @example 3262EFF25BA0D270 */ key_id: string; @@ -34648,7 +36075,7 @@ export interface components { * ] */ subkeys: { - /** Format: int64 */ + /** @format int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -34663,7 +36090,9 @@ export interface components { can_encrypt_storage?: boolean; can_certify?: boolean; created_at?: string; + /** @nullable */ expires_at?: string | null; + /** @nullable */ raw_key?: string | null; revoked?: boolean; }[]; @@ -34674,14 +36103,18 @@ export interface components { /** @example true */ can_certify: boolean; /** - * Format: date-time * @example 2016-03-24T11:31:04-06:00 + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; /** @example true */ revoked: boolean; + /** @nullable */ raw_key: string | null; }; /** @@ -34690,26 +36123,32 @@ export interface components { */ key: { key: string; - /** Format: int64 */ + /** @format int64 */ id: number; url: string; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; verified: boolean; read_only: boolean; }; /** Marketplace Account */ "marketplace-account": { - /** Format: uri */ + /** @format uri */ url: string; id: number; type: string; node_id?: string; login: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ organization_billing_email?: string | null; }; /** @@ -34720,21 +36159,25 @@ export interface components { /** @example monthly */ billing_cycle: string; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ next_billing_date: string | null; + /** @nullable */ unit_count: number | null; /** @example true */ on_free_trial: boolean; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ free_trial_ends_on: string | null; /** - * Format: date-time + * @nullable * @example 2017-11-02T01:12:12Z + * @format date-time */ updated_at: string | null; account: components["schemas"]["marketplace-account"]; @@ -34758,7 +36201,7 @@ export interface components { key: string; id: number; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; }; /** @@ -34766,7 +36209,7 @@ export interface components { * @description Starred Repository */ "starred-repository": { - /** Format: date-time */ + /** @format date-time */ starred_at: string; repo: components["schemas"]["repository"]; }; @@ -34795,9 +36238,11 @@ export interface components { inclusionPromise?: { signedEntryTimestamp?: string; }; + /** @nullable */ inclusionProof?: string | null; canonicalizedBody?: string; }[]; + /** @nullable */ timestampVerificationData?: string | null; }; dsseEnvelope?: { @@ -34834,16 +36279,20 @@ export interface components { * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." */ "enterprise-webhooks": { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -34864,16 +36313,18 @@ export interface components { */ slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** @@ -34907,18 +36358,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -34931,7 +36382,10 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; }; /** @@ -34941,9 +36395,9 @@ export interface components { */ "repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -34972,16 +36426,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -35003,28 +36460,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -35046,13 +36503,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -35066,30 +36523,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -35097,25 +36554,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -35190,18 +36650,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -35210,6 +36673,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id?: number; node_id?: string; @@ -35456,7 +36920,7 @@ export interface components { authorized_actors_only: boolean; authorized_dismissal_actors_only: boolean; create_protected?: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; dismiss_stale_reviews_on_push: boolean; id: number; @@ -35490,24 +36954,34 @@ export interface components { /** @enum {string} */ signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; strict_required_status_checks_policy: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ after?: string | null; app?: components["schemas"]["integration"]; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ before?: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch?: string | null; /** * @description The SHA of the head commit that is being checked. @@ -35525,7 +36999,7 @@ export interface components { * @enum {string} */ status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ url?: string; @@ -35538,11 +37012,13 @@ export interface components { app: components["schemas"]["nullable-integration"]; check_suite: components["schemas"]["simple-check-suite"]; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ completed_at: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ @@ -35573,16 +37049,19 @@ export interface components { node_id: string; output: { annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; + /** @nullable */ summary: string | null; + /** @nullable */ text: string | null; + /** @nullable */ title: string | null; }; pull_requests: components["schemas"]["pull-request-minimal"][]; /** - * Format: date-time * @example 2018-05-04T01:14:52Z + * @format date-time */ started_at: string; /** @@ -35604,34 +37083,39 @@ export interface components { webhooks_ref_0: string; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ webhooks_deploy_key: { + /** @nullable */ added_by?: string | null; created_at: string; id: number; key: string; + /** @nullable */ last_used?: string | null; read_only: boolean; title: string; - /** Format: uri */ + /** @format uri */ url: string; verified: boolean; enabled?: boolean; }; - /** Workflow */ + /** + * Workflow + * @nullable + */ webhooks_workflow: { - /** Format: uri */ + /** @format uri */ badge_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; node_id: string; path: string; state: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; webhooks_approver: { @@ -35656,92 +37140,102 @@ export interface components { user_view_type?: string; }; webhooks_reviewers: { - /** User */ + /** + * User + * @nullable + */ reviewer?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @enum {string} */ type?: "User"; }[]; webhooks_workflow_job_run: { + /** @nullable */ conclusion: unknown; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: unknown; status: string; updated_at: string; }; - /** User */ + /** + * User + * @nullable + */ webhooks_user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35754,12 +37248,13 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; child_comment_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; discussion_id: number; html_url: string; id: number; node_id: string; + /** @nullable */ parent_id: unknown; /** Reactions */ reactions?: { @@ -35772,48 +37267,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35823,46 +37322,53 @@ export interface components { * @description A Discussion in a repository. */ discussion: { + /** @nullable */ active_lock_reason: string | null; + /** @nullable */ answer_chosen_at: string | null; - /** User */ + /** + * User + * @nullable + */ answer_chosen_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ answer_html_url: string | null; /** * AuthorAssociation @@ -35872,7 +37378,7 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; category: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -35885,7 +37391,7 @@ export interface components { updated_at: string; }; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; html_url: string; id: number; @@ -35903,7 +37409,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; @@ -35915,6 +37421,7 @@ export interface components { */ state: "open" | "closed" | "locked" | "converting" | "transferring"; /** + * @nullable * @description The reason for the current state * @example resolved * @enum {string|null} @@ -35922,44 +37429,48 @@ export interface components { state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; timeline_url?: string; title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35979,6 +37490,7 @@ export interface components { html_url: string; id: number; node_id: string; + /** @nullable */ parent_id: number | null; /** Reactions */ reactions: { @@ -35991,47 +37503,51 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36041,14 +37557,15 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }; @@ -36092,16 +37609,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: components["schemas"]["integration"]; @@ -36116,52 +37633,56 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36178,80 +37699,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ webhooks_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -36261,95 +37790,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36362,67 +37910,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36501,19 +38064,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -36527,10 +38096,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -36543,54 +38112,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36600,56 +38174,67 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36662,9 +38247,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -36672,80 +38257,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ webhooks_issue_2: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -36755,95 +38348,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36856,67 +38468,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36995,19 +38622,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -37021,10 +38654,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -37037,93 +38670,102 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** User */ + /** + * User + * @nullable + */ webhooks_user_mannequin: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -37133,11 +38775,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date: string | null; on_free_trial: boolean; plan: { @@ -37149,6 +38794,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -37160,11 +38806,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: unknown; + /** @nullable */ next_billing_date?: string | null; on_free_trial: boolean; plan: { @@ -37176,6 +38825,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -37187,25 +38837,32 @@ export interface components { */ webhooks_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -37219,12 +38876,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -37234,12 +38891,12 @@ export interface components { privacy?: "open" | "closed" | "secret"; /** @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -37260,14 +38917,15 @@ export interface components { }; /** * Repository + * @nullable * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -37296,16 +38954,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -37327,28 +38988,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -37370,13 +39031,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -37390,30 +39051,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -37421,25 +39082,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -37514,18 +39178,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -37534,6 +39201,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id?: number; node_id?: string; @@ -37771,56 +39439,67 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone_3: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -37833,9 +39512,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -37843,48 +39522,52 @@ export interface components { * @description The membership between the user and the organization. Not present when the action is `member_invited`. */ webhooks_membership: { - /** Format: uri */ + /** @format uri */ organization_url: string; role: string; state: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -37938,9 +39621,15 @@ export interface components { * @enum {string} */ repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ repositories: { full_name: string; /** @description Unique identifier of the repository */ @@ -37959,154 +39648,174 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** Project Card */ webhooks_project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project */ webhooks_project: { - /** @description Body of the project */ + /** + * @nullable + * @description Body of the project + */ body: string | null; - /** Format: uri */ + /** @format uri */ columns_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Name of the project */ name: string; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ owner_url: string; /** * @description State of the project; either 'open' or 'closed' * @enum {string} */ state: "open" | "closed"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project Column */ webhooks_project_column: { + /** @nullable */ after_id?: number | null; - /** Format: uri */ + /** @format uri */ cards_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The unique identifier of the project column */ id: number; /** @description Name of the project column */ name: string; node_id: string; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -38119,37 +39828,47 @@ export interface components { owner: components["schemas"]["simple-user"]; creator: components["schemas"]["simple-user"]; title: string; + /** @nullable */ description: string | null; public: boolean; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; number: number; + /** @nullable */ short_description: string | null; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ deleted_at: string | null; deleted_by: components["schemas"]["nullable-simple-user"]; }; webhooks_project_changes: { archived_at?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ from?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ to?: string | null; }; }; @@ -38171,18 +39890,19 @@ export interface components { content_type: components["schemas"]["projects-v2-item-content-type"]; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ archived_at: string | null; }; @@ -38193,7 +39913,9 @@ export interface components { "projects-v2-single-select-option": { id: string; name: string; + /** @nullable */ color?: string | null; + /** @nullable */ description?: string | null; }; /** @@ -38203,7 +39925,9 @@ export interface components { "projects-v2-iteration-setting": { id: string; title: string; + /** @nullable */ duration?: number | null; + /** @nullable */ start_date?: string | null; }; /** @@ -38216,28 +39940,32 @@ export interface components { project_node_id?: string; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** - * Format: date * @example 2022-04-28 + * @format date */ start_date?: string; /** - * Format: date * @example 2022-04-28 + * @format date */ target_date?: string; /** + * @nullable * @description Body of the status update * @example The project is off to a great start! */ @@ -38299,120 +40027,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -38423,48 +40159,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -38505,32 +40252,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -38540,28 +40287,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -38589,37 +40337,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -38640,55 +40396,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -38702,11 +40465,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -38729,26 +40494,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -38763,60 +40528,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -38851,32 +40624,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -38886,28 +40659,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -38935,37 +40709,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -38986,55 +40768,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39048,11 +40837,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -39075,26 +40866,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -39109,168 +40900,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -39283,73 +41101,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -39358,12 +41185,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -39371,36 +41198,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -39409,12 +41243,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -39422,69 +41256,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39497,17 +41335,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -39521,20 +41359,23 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; @@ -39544,17 +41385,26 @@ export interface components { original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -39568,7 +41418,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -39576,9 +41426,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -39589,49 +41443,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39641,12 +41499,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -39656,60 +41514,71 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; state: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ submitted_at: string | null; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ webhooks_nullable_string: string | null; /** * Release @@ -39717,13 +41586,14 @@ export interface components { */ webhooks_release: { assets: { - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -39734,103 +41604,119 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; }[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -39843,20 +41729,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; /** @@ -39865,13 +41757,14 @@ export interface components { */ webhooks_release_1: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -39882,103 +41775,119 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -39991,20 +41900,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; /** @@ -40017,48 +41932,55 @@ export interface components { created_at: string; dismiss_reason?: string; dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -40070,6 +41992,7 @@ export interface components { state: "open"; }; /** + * @nullable * @description The reason for resolving the alert. * @enum {string|null} */ @@ -40081,18 +42004,22 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; @@ -40106,33 +42033,51 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or business. + */ multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { cvss: { score: number; + /** @nullable */ vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -40148,13 +42093,14 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; summary: string; updated_at: string; vulnerabilities: { + /** @nullable */ first_patched_version: { identifier: string; } | null; @@ -40165,6 +42111,7 @@ export interface components { severity: string; vulnerable_version_range: string; }[]; + /** @nullable */ withdrawn_at: string | null; }; webhooks_sponsorship: { @@ -40192,79 +42139,87 @@ export interface components { }; node_id: string; privacy_level: string; - /** User */ + /** + * User + * @nullable + */ sponsor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** User */ + /** + * User + * @nullable + */ sponsorable: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40311,25 +42266,32 @@ export interface components { */ webhooks_team_1: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -40343,12 +42305,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -40361,12 +42323,12 @@ export interface components { * @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -40419,15 +42381,18 @@ export interface components { /** @description If the action was `edited`, the changes to the rule. */ changes?: { admin_enforced?: { + /** @nullable */ from: boolean | null; }; authorized_actor_names?: { from: string[]; }; authorized_actors_only?: { + /** @nullable */ from: boolean | null; }; authorized_dismissal_actors_only?: { + /** @nullable */ from: boolean | null; }; linear_history_requirement_enforcement_level?: { @@ -40439,6 +42404,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; lock_allows_fork_sync?: { + /** @nullable */ from: boolean | null; }; pull_request_reviews_enforcement_level?: { @@ -40446,6 +42412,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; require_last_push_approval?: { + /** @nullable */ from: boolean | null; }; required_status_checks?: { @@ -40546,63 +42513,81 @@ export interface components { action: "completed"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description The client ID of the GitHub app */ + /** + * @nullable + * @description The client ID of the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40681,20 +42666,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -40703,9 +42696,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40716,9 +42712,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40742,7 +42741,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -40753,28 +42752,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -40790,63 +42790,81 @@ export interface components { action: "requested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description Client ID of the GitHub app */ + /** + * @nullable + * @description Client ID of the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40925,20 +42943,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -40947,9 +42973,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40960,9 +42989,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40986,7 +43018,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -40997,28 +43029,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -41034,63 +43067,81 @@ export interface components { action: "rerequested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description The Client ID for the GitHub app */ + /** + * @nullable + * @description The Client ID for the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -41169,20 +43220,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -41191,9 +43250,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -41204,9 +43266,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -41230,7 +43295,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -41241,28 +43306,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -41279,67 +43345,79 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41375,12 +43453,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41388,10 +43468,13 @@ export interface components { tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41409,67 +43492,78 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41503,17 +43597,23 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** @@ -41522,13 +43622,17 @@ export interface components { */ state: "dismissed" | "fixed"; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41546,25 +43650,39 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time + * @nullable * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: unknown; + /** @nullable */ dismissed_by: unknown; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41598,33 +43716,46 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | null; + /** @nullable */ tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; } | null; + /** @nullable */ updated_at?: string | null; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41642,69 +43773,81 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41738,32 +43881,43 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "fixed" | null; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41778,27 +43932,43 @@ export interface components { "webhook-code-scanning-alert-reopened": { /** @enum {string} */ action: "reopened"; - /** @description The code scanning alert involved in the event. */ + /** + * @nullable + * @description The code scanning alert involved in the event. + */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: string | null; + /** @nullable */ dismissed_by: Record | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: string | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41832,40 +44002,57 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | "fixed" | null; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; } | null; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ commit_oid: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -41877,24 +44064,37 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: unknown; + /** @nullable */ dismissed_by: unknown; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41930,12 +44130,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41943,10 +44145,13 @@ export interface components { tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41977,17 +44182,26 @@ export interface components { /** @description The SHA of the commit to which the comment applies. */ commit_id: string; created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The ID of the commit comment. */ id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the commit comment. */ node_id: string; - /** @description The relative path of the file to which the comment applies. */ + /** + * @nullable + * @description The relative path of the file to which the comment applies. + */ path: string | null; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; /** Reactions */ reactions?: { @@ -42000,48 +44214,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42054,7 +44272,10 @@ export interface components { }; /** create event */ "webhook-create": { - /** @description The repository's current description. */ + /** + * @nullable + * @description The repository's current description. + */ description: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; @@ -42242,44 +44463,49 @@ export interface components { */ deployment: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; environment: string; id: number; @@ -42288,58 +44514,73 @@ export interface components { payload: Record | string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42418,20 +44659,23 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -42440,43 +44684,50 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42485,13 +44736,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: unknown; head_repository?: { archive_url?: string; @@ -42505,6 +44760,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -42561,7 +44817,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -42569,6 +44825,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: unknown; pull_requests: { base: { @@ -42577,7 +44834,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -42588,16 +44845,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -42615,6 +44873,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -42673,51 +44932,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -42732,8 +44995,8 @@ export interface components { /** @description The event that triggered the deployment protection rule. */ event?: string; /** - * Format: uri * @description The URL to review the deployment protection rule. + * @format uri */ deployment_callback_url?: string; deployment?: components["schemas"]["deployment"]; @@ -42757,52 +45020,61 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { + /** @nullable */ conclusion?: unknown; created_at?: string; environment?: string; html_url?: string; id?: number; + /** @nullable */ name?: string | null; status?: string; updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42811,13 +45083,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url?: string; @@ -42831,6 +45107,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -42888,7 +45165,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -42896,6 +45173,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -42904,7 +45182,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -42915,16 +45193,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -42942,6 +45221,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43001,51 +45281,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43065,52 +45349,61 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { + /** @nullable */ conclusion?: string | null; created_at?: string; environment?: string; html_url?: string; id?: number; + /** @nullable */ name?: string | null; status?: string; updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43119,12 +45412,16 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url?: string; @@ -43138,6 +45435,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43195,7 +45493,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -43203,6 +45501,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -43211,7 +45510,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -43222,16 +45521,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -43249,6 +45549,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43308,51 +45609,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43369,41 +45674,45 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; requestor: components["schemas"]["webhooks_user"]; reviewers: { - /** User */ + /** + * User + * @nullable + */ reviewer?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43413,52 +45722,61 @@ export interface components { sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { + /** @nullable */ conclusion: unknown; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: string | null; status: string; updated_at: string; }; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43467,12 +45785,16 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url?: string; @@ -43486,6 +45808,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43543,7 +45866,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -43551,6 +45874,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -43559,7 +45883,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -43570,16 +45894,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -43597,6 +45922,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43656,51 +45982,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43711,34 +46041,39 @@ export interface components { "webhook-deployment-status-created": { /** @enum {string} */ action: "created"; + /** @nullable */ check_run?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ completed_at: string | null; /** + * @nullable * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ + /** @format uri */ details_url: string; external_id: string; /** @description The SHA of the commit that is being checked. */ head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The id of the check. */ id: number; /** @description The name of the check run. */ name: string; node_id: string; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ + /** @format uri */ url: string; } | null; /** @@ -43747,104 +46082,125 @@ export interface components { */ deployment: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; environment: string; id: number; node_id: string; original_environment: string; + /** @nullable */ payload: (string | Record) | null; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43923,128 +46279,150 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ deployment_url: string; /** @description The optional human-readable description added to the status. */ description: string; environment: string; - /** Format: uri */ + /** @format uri */ environment_url?: string; id: number; - /** Format: uri */ + /** @format uri */ log_url?: string; node_id: string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44123,17 +46501,20 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; - /** Format: uri */ + /** @format uri */ repository_url: string; /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ state: string; /** @description The optional link added to the status. */ target_url: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -44142,43 +46523,50 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run?: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44187,13 +46575,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: unknown; head_repository?: { archive_url?: string; @@ -44207,6 +46599,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -44263,7 +46656,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -44271,6 +46664,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: unknown; pull_requests: { base: { @@ -44279,7 +46673,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -44290,16 +46684,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -44317,6 +46712,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -44375,51 +46771,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -44444,7 +46844,7 @@ export interface components { changes: { category: { from: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -44693,32 +47093,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -44728,28 +47128,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -44772,89 +47173,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44868,36 +47284,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -44922,6 +47340,7 @@ export interface components { created_at?: string; default_branch?: string; deployments_url?: string; + /** @nullable */ description?: string | null; disabled?: boolean; downloads_url?: string; @@ -44941,6 +47360,7 @@ export interface components { has_pages?: boolean; has_projects?: boolean; has_wiki?: boolean; + /** @nullable */ homepage?: string | null; hooks_url?: string; html_url?: string; @@ -44951,11 +47371,14 @@ export interface components { issues_url?: string; keys_url?: string; labels_url?: string; + /** @nullable */ language?: unknown; languages_url?: string; + /** @nullable */ license?: Record | null; merges_url?: string; milestones_url?: string; + /** @nullable */ mirror_url?: unknown; name?: string; node_id?: string; @@ -45029,14 +47452,15 @@ export interface components { */ action: "created" | "edited"; /** - * Format: uri * @description Points to the HTML wiki page. + * @format uri */ html_url: string; /** @description The name of the page. */ page_name: string; /** @description The latest commit SHA of the page. */ sha: string; + /** @nullable */ summary: string | null; /** @description The current page title. */ title: string; @@ -45065,6 +47489,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45077,6 +47502,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45137,14 +47563,17 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { + /** @nullable */ archived_at?: string | null; avatar_url: string; created_at?: string; + /** @nullable */ description?: unknown; events_url?: string; followers?: number; @@ -45177,6 +47606,7 @@ export interface components { type?: string; updated_at?: string; url?: string; + /** @nullable */ website_url?: unknown; user_view_type?: string; }; @@ -45206,6 +47636,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45226,16 +47657,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -45250,52 +47681,56 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45304,80 +47739,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -45387,95 +47830,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -45488,67 +47950,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45627,19 +48104,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -45653,10 +48136,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -45669,100 +48152,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -45774,22 +48269,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -45821,7 +48319,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -45848,80 +48346,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -45931,95 +48437,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -46032,67 +48557,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46171,19 +48711,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -46197,10 +48743,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -46213,100 +48759,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -46318,22 +48876,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -46365,7 +48926,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -46394,80 +48955,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -46477,95 +49046,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -46578,67 +49166,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46717,19 +49320,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -46743,10 +49352,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -46759,100 +49368,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -46864,22 +49485,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -46911,7 +49535,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -46955,80 +49579,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -47038,95 +49670,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -47139,67 +49790,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47278,19 +49944,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -47304,10 +49976,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -47320,63 +49992,72 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; + /** @nullable */ assignee?: Record | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at: string | null; comments?: number; comments_url?: string; @@ -47387,9 +50068,11 @@ export interface components { labels?: (Record | null)[]; labels_url?: string; locked?: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -47418,7 +50101,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -47448,80 +50131,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -47530,95 +50221,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -47631,67 +50341,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47770,19 +50495,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -47796,10 +50527,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -47812,54 +50543,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47879,79 +50615,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -47960,95 +50704,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48061,67 +50824,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48200,19 +50978,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -48226,10 +51010,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -48242,54 +51026,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48321,80 +51110,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -48403,95 +51200,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48504,67 +51320,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48643,19 +51474,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -48669,10 +51506,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -48685,54 +51522,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48753,80 +51595,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -48835,95 +51685,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48936,67 +51805,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49075,19 +51959,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49101,10 +51991,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49117,54 +52007,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49185,80 +52080,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -49268,96 +52171,115 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: true; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -49370,67 +52292,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49509,19 +52446,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49535,10 +52478,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49551,54 +52494,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49618,79 +52566,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -49699,95 +52655,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -49800,67 +52775,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49939,19 +52929,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49965,10 +52961,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49981,54 +52977,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50045,83 +53046,92 @@ export interface components { changes?: { /** * Issue + * @nullable * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ old_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50131,95 +53141,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50232,67 +53261,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50371,19 +53415,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -50397,10 +53447,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -50413,54 +53463,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50493,32 +53548,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -50532,28 +53587,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** @description Whether the repository has discussions enabled. */ has_discussions?: boolean; @@ -50578,89 +53634,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50674,36 +53745,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -50720,80 +53793,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50803,95 +53884,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50904,67 +54004,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51043,19 +54158,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51069,10 +54190,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51085,54 +54206,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51163,79 +54289,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -51244,95 +54378,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51345,67 +54498,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51484,19 +54652,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51510,10 +54684,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51526,54 +54700,59 @@ export interface components { * @enum {string} */ state: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51592,80 +54771,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ new_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -51675,95 +54862,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51776,67 +54982,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51915,19 +55136,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51941,10 +55168,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51957,54 +55184,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52037,32 +55269,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -52076,28 +55308,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -52125,89 +55358,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52221,36 +55469,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -52305,80 +55555,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -52388,96 +55646,115 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: false; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -52490,67 +55767,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52629,19 +55921,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -52655,10 +55953,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -52671,54 +55969,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52814,12 +56117,16 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date?: string | null; + /** @nullable */ on_free_trial: boolean | null; plan: { bullets: string[]; @@ -52830,6 +56137,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52853,11 +56161,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date?: string | null; on_free_trial: boolean; plan: { @@ -52869,6 +56180,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52890,11 +56202,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: unknown; + /** @nullable */ next_billing_date: string | null; on_free_trial: boolean; plan: { @@ -52906,6 +56221,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52967,7 +56283,9 @@ export interface components { from: string; }; permission?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; }; @@ -53003,41 +56321,45 @@ export interface components { * @enum {string} */ scope: "team"; - /** User */ + /** + * User + * @nullable + */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53057,41 +56379,45 @@ export interface components { * @enum {string} */ scope: "team" | "organization"; - /** User */ + /** + * User + * @nullable + */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53133,7 +56459,7 @@ export interface components { content_type: "json" | "form"; insecure_ssl: string; secret?: string; - /** Format: uri */ + /** @format uri */ url: string; }; created_at: string; @@ -53272,53 +56598,63 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ invitation: { - /** Format: date-time */ + /** @format date-time */ created_at: string; + /** @nullable */ email: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ failed_at: string | null; + /** @nullable */ failed_reason: string | null; id: number; - /** Format: uri */ + /** @format uri */ invitation_teams_url: string; - /** User */ + /** + * User + * @nullable + */ inviter: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ login: string | null; node_id: string; role: string; @@ -53385,96 +56721,110 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ package: { + /** @nullable */ created_at: string | null; + /** @nullable */ description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; package_type: string; + /** @nullable */ package_version: { - /** User */ + /** + * User + * @nullable + */ author?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; body?: string | Record; body_html?: string; + /** @nullable */ container_metadata?: { + /** @nullable */ labels?: Record | null; + /** @nullable */ manifest?: Record | null; tag?: { digest?: string; @@ -53487,7 +56837,7 @@ export interface components { tags?: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -53496,22 +56846,27 @@ export interface components { [key: string]: unknown; }[]; name: string; + /** @nullable */ npm_metadata?: { name?: string; version?: string; npm_user?: string; + /** @nullable */ author?: Record | null; + /** @nullable */ bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; + /** @nullable */ dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; + /** @nullable */ repository?: Record | null; scripts?: Record; id?: string; @@ -53525,6 +56880,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; + /** @nullable */ directories?: Record | null; os?: string[]; cpu?: string[]; @@ -53535,6 +56891,7 @@ export interface components { published_via_actions?: boolean; deleted_by_id?: number; } | null; + /** @nullable */ nuget_metadata?: { id?: number | string; name?: string; @@ -53548,69 +56905,78 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; + /** @nullable */ sha256: string | null; size: number; + /** @nullable */ state: string | null; updated_at: string; }[]; package_url?: string; prerelease?: boolean; release?: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; prerelease: boolean; published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; @@ -53622,15 +56988,17 @@ export interface components { updated_at?: string; version: string; } | null; + /** @nullable */ registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; + /** @nullable */ updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; @@ -53646,88 +57014,97 @@ export interface components { /** @description Information about the package. */ package: { created_at: string; + /** @nullable */ description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; package_type: string; package_version: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53739,7 +57116,7 @@ export interface components { tags?: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -53751,11 +57128,13 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; sha256: string; size: number; @@ -53765,47 +57144,51 @@ export interface components { package_url?: string; prerelease?: boolean; release?: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; @@ -53813,11 +57196,11 @@ export interface components { published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - /** Format: uri */ + /** @format uri */ source_url?: string; summary: string; tag_name?: string; @@ -53826,12 +57209,13 @@ export interface components { updated_at: string; version: string; }; + /** @nullable */ registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; @@ -53844,53 +57228,59 @@ export interface components { "webhook-page-build": { /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ build: { + /** @nullable */ commit: string | null; created_at: string; duration: number; error: { + /** @nullable */ message: string | null; }; - /** User */ + /** + * User + * @nullable + */ pusher: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; status: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -53956,9 +57346,9 @@ export interface components { secret?: components["schemas"]["webhook-config-secret"]; url?: components["schemas"]["webhook-config-url"]; }; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ deliveries_url?: string; /** @description Determines what events the hook is triggered for. Default: ['push']. */ events: string[]; @@ -53970,14 +57360,14 @@ export interface components { * @enum {string} */ name: "web"; - /** Format: uri */ + /** @format uri */ ping_url?: string; - /** Format: uri */ + /** @format uri */ test_url?: string; type: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** @description The ID of the webhook that triggered the ping. */ @@ -54029,63 +57419,70 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; + /** @nullable */ column_id: number | null; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; @@ -54097,6 +57494,7 @@ export interface components { action: "edited"; changes: { note: { + /** @nullable */ from: string | null; }; }; @@ -54120,70 +57518,78 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } & { + /** @nullable */ after_id: number | null; archived?: boolean; column_id?: number; column_url?: string; created_at?: string; + /** @nullable */ creator?: { avatar_url?: string; events_url?: string; @@ -54206,6 +57612,7 @@ export interface components { } | null; id?: number; node_id?: string; + /** @nullable */ note?: string | null; project_url?: string; updated_at?: string; @@ -54362,7 +57769,9 @@ export interface components { action: "edited"; changes: { description?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; public?: { @@ -54370,7 +57779,9 @@ export interface components { to?: boolean; }; short_description?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; title?: { @@ -54399,6 +57810,7 @@ export interface components { action: "converted"; changes: { content_type?: { + /** @nullable */ from?: string | null; to?: string; }; @@ -54440,12 +57852,16 @@ export interface components { field_type?: string; field_name?: string; project_number?: number; + /** @nullable */ from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + /** @nullable */ to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; }; } | { body: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; }; @@ -54460,7 +57876,9 @@ export interface components { action: "reordered"; changes: { previous_projects_v2_item_node_id?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; }; @@ -54512,25 +57930,45 @@ export interface components { action: "edited"; changes?: { body?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; status?: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; start_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ to?: string | null; }; target_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ to?: string | null; }; }; @@ -54561,120 +57999,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -54686,48 +58132,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54768,32 +58225,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -54803,28 +58260,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -54852,37 +58310,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -54903,55 +58369,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54965,11 +58438,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -54992,26 +58467,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55026,68 +58501,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -55114,32 +58599,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -55149,28 +58634,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -55198,37 +58684,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -55249,55 +58743,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55311,11 +58812,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -55338,26 +58841,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55372,168 +58875,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -55546,74 +59076,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -55622,12 +59161,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -55635,36 +59174,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -55673,12 +59219,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -55686,69 +59232,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55769,120 +59319,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -55893,48 +59451,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55975,32 +59544,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -56010,28 +59579,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -56059,37 +59629,45 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -56110,55 +59688,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56172,11 +59757,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -56199,26 +59786,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56233,60 +59820,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -56321,32 +59916,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -56356,28 +59951,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -56405,37 +60001,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -56456,55 +60060,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56518,11 +60129,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -56545,26 +60158,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56579,168 +60192,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -56753,74 +60393,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -56829,12 +60478,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -56842,36 +60491,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -56880,12 +60536,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -56893,69 +60549,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56977,120 +60637,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -57101,48 +60769,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57183,32 +60862,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -57218,28 +60897,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -57267,37 +60947,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -57318,55 +61006,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57380,11 +61075,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -57407,26 +61104,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57441,60 +61138,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -57529,32 +61234,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -57564,28 +61269,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -57613,34 +61319,42 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -57661,55 +61375,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57723,11 +61444,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -57750,26 +61473,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57784,168 +61507,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -57958,74 +61708,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -58034,12 +61793,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -58047,36 +61806,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -58085,12 +61851,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -58098,69 +61864,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58218,120 +61988,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -58342,48 +62120,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58424,32 +62213,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -58459,28 +62248,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -58508,37 +62298,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -58559,55 +62357,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58621,11 +62426,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -58648,26 +62455,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -58682,60 +62489,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -58770,32 +62585,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -58805,28 +62620,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -58854,37 +62670,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -58905,55 +62729,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58967,11 +62798,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -58994,26 +62827,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59028,168 +62861,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -59202,74 +63062,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59278,12 +63147,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59291,36 +63160,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59329,12 +63205,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59342,69 +63218,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59458,120 +63338,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -59582,48 +63470,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59664,32 +63563,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -59699,28 +63598,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -59748,37 +63648,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -59799,55 +63707,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59861,11 +63776,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -59888,26 +63805,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59922,60 +63839,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -60010,32 +63935,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60045,28 +63970,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60094,37 +64020,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -60145,55 +64079,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60207,11 +64148,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -60234,26 +64177,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -60268,168 +64211,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -60442,74 +64412,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -60518,12 +64497,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -60531,36 +64510,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -60569,12 +64555,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -60582,69 +64568,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60666,120 +64656,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -60790,48 +64788,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60872,32 +64881,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60907,28 +64916,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60956,37 +64966,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -61007,55 +65025,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61069,11 +65094,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -61096,26 +65123,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61130,68 +65157,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -61218,32 +65255,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -61253,28 +65290,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -61302,37 +65340,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -61353,55 +65399,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61415,11 +65468,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -61442,26 +65497,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61476,168 +65531,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -61650,74 +65732,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61726,12 +65817,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61739,36 +65830,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61777,12 +65875,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61790,69 +65888,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61873,120 +65975,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -61997,48 +66107,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62079,32 +66200,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -62114,28 +66235,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -62163,37 +66285,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -62214,55 +66344,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62276,11 +66413,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -62303,26 +66442,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62337,68 +66476,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -62425,32 +66574,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -62460,28 +66609,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -62509,37 +66659,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -62560,55 +66718,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62622,11 +66787,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -62649,26 +66816,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62683,168 +66850,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -62857,74 +67051,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62933,12 +67136,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62946,36 +67149,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62984,12 +67194,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62997,69 +67207,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63127,17 +67341,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -63151,40 +67365,55 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -63198,7 +67427,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -63206,9 +67435,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -63219,49 +67452,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63273,119 +67510,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -63396,48 +67641,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63478,32 +67734,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63513,28 +67769,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63562,37 +67819,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -63613,55 +67878,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63675,11 +67947,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -63702,26 +67976,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -63736,54 +68010,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -63791,6 +68071,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -63817,32 +68098,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63852,28 +68133,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63901,37 +68183,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -63952,55 +68242,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64014,11 +68311,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -64041,26 +68340,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64075,124 +68374,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -64205,72 +68523,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64279,12 +68605,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64292,36 +68618,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64330,12 +68663,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64343,63 +68676,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64419,119 +68756,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -64542,48 +68887,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64624,32 +68980,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -64659,28 +69015,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -64708,37 +69065,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -64759,55 +69124,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64821,11 +69193,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -64848,26 +69222,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64882,54 +69256,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -64937,6 +69317,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -64963,32 +69344,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -64998,28 +69379,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65047,37 +69429,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -65098,55 +69488,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65160,11 +69557,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -65187,26 +69586,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -65221,124 +69620,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -65351,72 +69769,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65425,12 +69851,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -65438,36 +69864,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65476,12 +69909,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -65489,63 +69922,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65566,119 +70003,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -65690,48 +70135,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65772,32 +70228,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -65807,28 +70263,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65856,37 +70313,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -65907,55 +70372,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65969,11 +70441,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -65996,26 +70470,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66030,54 +70504,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -66085,6 +70565,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -66111,32 +70592,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66146,28 +70627,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -66195,37 +70677,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -66246,55 +70736,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66308,11 +70805,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -66335,26 +70834,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66369,124 +70868,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -66499,72 +71017,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -66573,12 +71099,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -66586,36 +71112,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -66624,12 +71157,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -66637,64 +71170,68 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; user_view_type?: string; - /** Format: uri */ + /** @format uri */ url?: string; } | null; }; @@ -66713,119 +71250,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -66836,48 +71381,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66918,32 +71474,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66953,28 +71509,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -67002,37 +71559,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -67053,55 +71618,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67115,11 +71687,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -67142,26 +71716,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67176,54 +71750,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -67231,6 +71811,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -67257,32 +71838,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -67292,28 +71873,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -67341,37 +71923,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -67392,55 +71982,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67454,11 +72051,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -67481,26 +72080,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67515,124 +72114,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -67645,72 +72263,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67719,12 +72345,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67732,36 +72358,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67770,12 +72403,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67783,63 +72416,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67850,12 +72487,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -67865,57 +72502,64 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; /** @enum {string} */ state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ + /** @format date-time */ submitted_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67940,119 +72584,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -68063,48 +72715,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68145,32 +72808,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68180,28 +72843,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68224,89 +72888,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68320,36 +72999,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -68357,54 +73038,60 @@ export interface components { watchers_count: number; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -68412,6 +73099,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -68438,32 +73126,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68473,28 +73161,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68517,89 +73206,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68613,36 +73317,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -68650,124 +73356,143 @@ export interface components { watchers_count: number; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -68780,72 +73505,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68854,12 +73587,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68867,36 +73600,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68905,12 +73645,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68918,63 +73658,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68997,120 +73741,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -69122,48 +73874,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69204,32 +73967,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -69239,28 +74002,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -69288,37 +74052,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -69339,55 +74111,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69401,11 +74180,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -69421,26 +74202,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69455,60 +74236,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -69543,32 +74332,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -69578,28 +74367,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -69627,37 +74417,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -69678,55 +74476,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69740,11 +74545,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -69767,26 +74574,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69801,168 +74608,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -69975,74 +74809,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70051,12 +74894,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70064,36 +74907,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70102,12 +74952,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70115,109 +74965,117 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70235,120 +75093,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -70360,48 +75226,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70442,32 +75319,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70477,28 +75354,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70526,37 +75404,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -70577,55 +75463,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70639,11 +75532,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -70666,26 +75561,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -70700,60 +75595,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -70788,32 +75691,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70823,28 +75726,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70872,37 +75776,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -70923,55 +75835,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70985,11 +75904,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -71012,26 +75933,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71046,168 +75967,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -71220,74 +76168,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71296,12 +76253,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71309,36 +76266,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71347,12 +76311,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71360,69 +76324,73 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71434,25 +76402,32 @@ export interface components { */ requested_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71461,12 +76436,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71474,12 +76449,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }; @@ -71499,120 +76474,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -71624,48 +76607,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71706,32 +76700,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -71741,28 +76735,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -71790,37 +76785,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -71841,55 +76844,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71903,11 +76913,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -71930,26 +76942,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71964,60 +76976,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -72052,32 +77072,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72087,28 +77107,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -72136,37 +77157,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -72187,55 +77216,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72249,11 +77285,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -72276,26 +77314,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -72310,168 +77348,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -72484,74 +77549,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -72560,12 +77634,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -72573,36 +77647,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -72611,12 +77692,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -72624,109 +77705,117 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72744,120 +77833,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -72869,48 +77966,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72951,32 +78059,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72986,28 +78094,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73035,37 +78144,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -73086,55 +78203,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73148,11 +78272,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -73175,26 +78301,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73209,60 +78335,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -73297,32 +78431,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -73332,28 +78466,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73381,37 +78516,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -73432,55 +78575,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73494,11 +78644,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -73521,26 +78673,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73555,168 +78707,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -73729,74 +78908,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73805,12 +78993,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73818,36 +79006,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73856,12 +79051,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73869,69 +79064,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73943,25 +79142,32 @@ export interface components { */ requested_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73970,12 +79176,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73983,12 +79189,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -74006,119 +79212,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -74129,48 +79343,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74211,32 +79436,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -74246,28 +79471,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -74295,37 +79521,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -74346,55 +79580,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74408,11 +79649,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -74435,26 +79678,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74469,61 +79712,69 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -74550,32 +79801,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -74585,28 +79836,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -74634,37 +79886,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -74685,55 +79945,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74747,11 +80014,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -74774,26 +80043,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74808,124 +80077,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -74938,72 +80226,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75012,12 +80308,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75025,36 +80321,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75063,12 +80366,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75076,63 +80379,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75153,119 +80460,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -75276,48 +80591,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75358,32 +80684,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75393,28 +80719,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -75442,89 +80769,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75538,36 +80880,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -75577,61 +80921,69 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -75658,32 +81010,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75693,28 +81045,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -75742,89 +81095,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75838,36 +81206,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -75877,124 +81247,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -76007,72 +81396,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76081,12 +81478,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76094,36 +81491,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76132,12 +81536,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76145,63 +81549,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76213,17 +81621,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -76237,40 +81645,55 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -76284,7 +81707,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -76292,9 +81715,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -76305,49 +81732,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76367,119 +81798,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -76490,48 +81929,56 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; /** @description Title for the merge commit message. */ commit_title: string; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76572,32 +82019,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -76607,28 +82054,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76656,89 +82104,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76752,36 +82215,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -76791,54 +82256,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -76872,32 +82343,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -76907,28 +82378,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76956,89 +82428,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77052,36 +82539,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -77091,124 +82580,143 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -77221,72 +82729,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -77295,12 +82811,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -77308,36 +82824,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -77346,12 +82869,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -77359,63 +82882,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77427,17 +82954,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -77451,20 +82978,23 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; @@ -77474,17 +83004,26 @@ export interface components { original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -77498,7 +83037,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -77506,9 +83045,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -77519,49 +83062,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77584,120 +83131,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -77708,48 +83263,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77790,32 +83356,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -77825,28 +83391,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -77874,37 +83441,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -77925,55 +83500,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77987,11 +83569,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -78014,26 +83598,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78048,60 +83632,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -78136,32 +83728,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -78171,28 +83763,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -78220,37 +83813,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -78264,55 +83865,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78326,11 +83934,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -78353,26 +83963,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78387,168 +83997,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -78561,74 +84198,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78637,12 +84283,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78650,36 +84296,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78688,12 +84341,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78701,69 +84354,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78785,120 +84442,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -78909,48 +84574,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78961,6 +84637,7 @@ export interface components { merge_method: "merge" | "squash" | "rebase"; } | null; base: { + /** @nullable */ label: string | null; ref: string; /** @@ -78991,32 +84668,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79026,28 +84703,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79075,37 +84753,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -79126,55 +84812,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79188,11 +84881,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -79215,26 +84910,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79249,68 +84944,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -79337,32 +85042,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79372,28 +85077,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79421,37 +85127,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -79472,55 +85186,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79534,11 +85255,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -79561,26 +85284,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79595,168 +85318,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -79769,74 +85519,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79845,12 +85604,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79858,36 +85617,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79896,12 +85662,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79909,69 +85675,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79993,120 +85763,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -80117,48 +85895,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80199,32 +85988,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -80234,28 +86023,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -80283,37 +86073,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -80334,55 +86132,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80396,11 +86201,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -80423,26 +86230,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80457,68 +86264,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -80545,32 +86362,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -80580,28 +86397,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -80629,37 +86447,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -80673,55 +86499,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80735,11 +86568,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -80762,26 +86597,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80796,168 +86631,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -80970,74 +86832,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81046,12 +86917,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81059,36 +86930,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81097,12 +86975,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81110,69 +86988,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81193,120 +87075,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -81317,48 +87207,56 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; /** @description Title for the merge commit message. */ commit_title: string; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81399,32 +87297,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -81434,28 +87332,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -81483,37 +87382,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -81534,55 +87441,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81596,11 +87510,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -81623,26 +87539,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -81657,60 +87573,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -81719,6 +87643,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -81745,32 +87670,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -81780,28 +87705,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -81829,37 +87755,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -81880,55 +87814,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81942,11 +87883,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -81969,26 +87912,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -82003,168 +87946,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -82177,74 +88147,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82253,12 +88232,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82266,36 +88245,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82304,12 +88290,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82317,69 +88303,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82403,9 +88393,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82416,9 +88409,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82434,14 +88430,14 @@ export interface components { /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; }[]; @@ -82454,7 +88450,10 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ forced: boolean; - /** Commit */ + /** + * Commit + * @nullable + */ head_commit: { /** @description An array of files added in the commit. */ added?: string[]; @@ -82463,9 +88462,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82476,9 +88478,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82494,14 +88499,14 @@ export interface components { /** @description An array of files removed in the commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; } | null; @@ -82512,9 +88517,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ pusher: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; /** @description The git author's name. */ name: string; @@ -82550,32 +88558,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -82589,28 +88597,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -82638,89 +88647,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82734,36 +88758,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -82781,7 +88807,9 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { + /** @nullable */ created_at: string | null; + /** @nullable */ description: string | null; ecosystem: string; html_url: string; @@ -82810,6 +88838,7 @@ export interface components { user_view_type?: string; }; package_type: string; + /** @nullable */ package_version: { author?: { avatar_url: string; @@ -82835,7 +88864,9 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { + /** @nullable */ labels?: Record | null; + /** @nullable */ manifest?: Record | null; tag?: { digest?: string; @@ -82856,22 +88887,27 @@ export interface components { [key: string]: unknown; }[]; name: string; + /** @nullable */ npm_metadata?: { name?: string; version?: string; npm_user?: string; + /** @nullable */ author?: (string | Record) | null; + /** @nullable */ bugs?: (string | Record) | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; + /** @nullable */ dist?: (string | Record) | null; git_head?: string; homepage?: string; license?: string; main?: string; + /** @nullable */ repository?: (string | Record) | null; scripts?: Record; id?: string; @@ -82885,6 +88921,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; + /** @nullable */ directories?: (string | Record) | null; os?: string[]; cpu?: string[]; @@ -82895,7 +88932,9 @@ export interface components { published_via_actions?: boolean; deleted_by_id?: number; } | null; + /** @nullable */ nuget_metadata?: { + /** @nullable */ id?: (string | Record | number) | null; name?: string; value?: boolean | string | number | { @@ -82910,11 +88949,15 @@ export interface components { created_at: string; download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; + /** @nullable */ sha256: string | null; size: number; + /** @nullable */ state: string | null; updated_at: string; }[]; @@ -82946,6 +88989,7 @@ export interface components { draft?: boolean; html_url?: string; id?: number; + /** @nullable */ name?: string | null; prerelease?: boolean; published_at?: string; @@ -82961,6 +89005,7 @@ export interface components { updated_at?: string; version: string; } | null; + /** @nullable */ registry: { about_url?: string; name?: string; @@ -82968,6 +89013,7 @@ export interface components { url?: string; vendor?: string; } | null; + /** @nullable */ updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; @@ -82981,6 +89027,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { created_at: string; + /** @nullable */ description: unknown; ecosystem: string; html_url: string; @@ -83052,8 +89099,10 @@ export interface components { created_at?: string; download_url?: string; id?: number; + /** @nullable */ md5?: string | null; name?: string; + /** @nullable */ sha1?: string | null; sha256?: string; size?: number; @@ -83103,6 +89152,7 @@ export interface components { updated_at: string; version: string; }; + /** @nullable */ registry: Record | null; updated_at: string; }; @@ -83169,13 +89219,14 @@ export interface components { */ release: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -83186,98 +89237,111 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @@ -83285,7 +89349,10 @@ export interface components { * @enum {boolean} */ prerelease: true; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -83298,20 +89365,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -83407,7 +89480,10 @@ export interface components { /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ action: string; branch: string; - /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + /** + * @nullable + * @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + */ client_payload: { [key: string]: unknown; } | null; @@ -83426,12 +89502,15 @@ export interface components { from: string; }; description?: { + /** @nullable */ from: string | null; }; homepage?: { + /** @nullable */ from: string | null; }; topics?: { + /** @nullable */ from?: string[] | null; }; }; @@ -83577,65 +89656,70 @@ export interface components { from: { /** Organization */ organization?: { - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; - /** Format: uri */ + /** @format uri */ issues_url: string; login: string; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ public_members_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** User */ + /** + * User + * @nullable + */ user?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -83681,52 +89765,60 @@ export interface components { affected_package_name: string; affected_range: string; created_at: string; + /** @nullable */ dismiss_comment?: string | null; dismiss_reason: string; dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ dismisser: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -83768,48 +89860,55 @@ export interface components { created_at: string; dismiss_reason?: string; dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -83912,20 +90011,27 @@ export interface components { */ source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at: string; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at: string; - /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + /** + * @nullable + * @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates + */ secret_types?: string[] | null; - /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + /** + * @nullable + * @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated + */ custom_pattern_name?: string | null; /** + * @nullable * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated * @enum {string|null} */ @@ -83970,6 +90076,7 @@ export interface components { security_advisory: { cvss: { score: number; + /** @nullable */ vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -83985,13 +90092,14 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; summary: string; updated_at: string; vulnerabilities: { + /** @nullable */ first_patched_version: { identifier: string; } | null; @@ -84104,7 +90212,10 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ starred_at: string | null; }; /** star deleted event */ @@ -84116,68 +90227,85 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ starred_at: unknown; }; /** status event */ "webhook-status": { - /** Format: uri */ + /** + * @nullable + * @format uri + */ avatar_url?: string | null; /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */ branches: { commit: { + /** @nullable */ sha: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; name: string; protected: boolean; }[]; commit: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id?: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -84189,9 +90317,12 @@ export interface components { }; comment_count: number; committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -84204,74 +90335,84 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification: { + /** @nullable */ payload: string | null; /** @enum {string} */ reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; + /** @nullable */ signature: string | null; verified: boolean; + /** @nullable */ verified_at?: string | null; }; }; - /** User */ + /** + * User + * @nullable + */ committer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id?: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; node_id: string; parents: { - /** Format: uri */ + /** @format uri */ html_url: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }[]; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; context: string; created_at: string; - /** @description The optional human-readable description added to the status. */ + /** + * @nullable + * @description The optional human-readable description added to the status. + */ description: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ @@ -84288,7 +90429,10 @@ export interface components { * @enum {string} */ state: "pending" | "success" | "failure" | "error"; - /** @description The optional link added to the status. */ + /** + * @nullable + * @description The optional link added to the status. + */ target_url: string | null; updated_at: string; }; @@ -84400,32 +90544,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84439,28 +90583,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84483,89 +90628,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84579,36 +90739,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -84653,32 +90815,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84692,28 +90854,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84736,89 +90899,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84832,36 +91010,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -84906,32 +91086,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84945,28 +91125,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84989,89 +91170,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85085,36 +91281,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85190,32 +91388,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85229,28 +91427,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -85273,89 +91472,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85369,36 +91583,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85443,32 +91659,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85482,28 +91698,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -85526,89 +91743,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85622,36 +91854,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85674,6 +91908,7 @@ export interface components { /** workflow_dispatch event */ "webhook-workflow-dispatch": { enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @nullable */ inputs: { [key: string]: unknown; } | null; @@ -85694,15 +91929,19 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85711,15 +91950,27 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_name: string | null; started_at: string; /** @@ -85727,21 +91978,32 @@ export interface components { * @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "queued"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; @@ -85759,15 +92021,25 @@ export interface components { run_attempt?: number; run_id?: number; run_url?: string; + /** @nullable */ runner_group_id?: number | null; + /** @nullable */ runner_group_name?: string | null; + /** @nullable */ runner_id?: number | null; + /** @nullable */ runner_name?: string | null; started_at?: string; status?: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name?: string | null; steps?: (Record | null)[]; url?: string; @@ -85784,15 +92056,19 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | null | "cancelled" | "neutral"; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85801,15 +92077,27 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_name: string | null; started_at: string; /** @@ -85817,25 +92105,38 @@ export interface components { * @enum {string} */ status: "queued" | "in_progress" | "completed"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | null | "cancelled"; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; + /** @nullable */ completed_at?: string | null; + /** @nullable */ conclusion?: string | null; /** @description The time that the job created. */ created_at?: string; @@ -85848,22 +92149,35 @@ export interface components { run_attempt?: number; run_id?: number; run_url?: string; + /** @nullable */ runner_group_id?: number | null; + /** @nullable */ runner_group_name?: string | null; + /** @nullable */ runner_id?: number | null; + /** @nullable */ runner_name?: string | null; started_at?: string; /** @enum {string} */ status: "in_progress" | "completed" | "queued"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name?: string | null; steps: { + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "pending" | "queued"; @@ -85882,14 +92196,16 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -85897,31 +92213,46 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; + /** @nullable */ runner_group_id: number | null; + /** @nullable */ runner_group_name: string | null; + /** @nullable */ runner_id: number | null; + /** @nullable */ runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -85936,14 +92267,16 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -85951,31 +92284,46 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; + /** @nullable */ runner_group_id: number | null; + /** @nullable */ runner_group_name: string | null; + /** @nullable */ runner_id: number | null; + /** @nullable */ runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; /** @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -85992,57 +92340,65 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86051,9 +92407,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86064,9 +92423,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86079,143 +92441,152 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -86224,7 +92595,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -86235,16 +92606,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -86252,183 +92624,192 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. @@ -86449,56 +92830,64 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86507,9 +92896,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86520,9 +92912,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86535,142 +92930,154 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** @description The name of the repository. */ + /** + * @nullable + * @description The name of the repository. + */ name: string | null; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -86679,7 +93086,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -86690,16 +93097,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -86707,181 +93115,190 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; }; }; @@ -86897,57 +93314,65 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86956,9 +93381,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86969,9 +93397,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86984,143 +93415,152 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: { base: { @@ -87129,7 +93569,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -87140,16 +93580,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -87157,183 +93598,192 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; display_title: string; }; @@ -87450,6 +93900,7 @@ export interface components { block?: { reason?: string; created_at?: string; + /** @nullable */ html_url?: string | null; }; message?: string; @@ -88237,6 +94688,7 @@ export interface operations { "application/json": components["schemas"]["integration"] & ({ client_id: string; client_secret: string; + /** @nullable */ webhook_secret: string | null; pem: string; } & { @@ -89824,7 +96276,10 @@ export interface operations { [key: string]: { /** @description The new content of the file. */ content?: string; - /** @description The new filename for the file. */ + /** + * @nullable + * @description The new filename for the file. + */ filename?: string | null; } | null; }; @@ -90760,8 +97215,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at?: string; /** @description Whether the notification has been read. */ @@ -91359,7 +97814,10 @@ export interface operations { * @enum {string} */ source?: "github" | "partner" | "custom"; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ version?: string | null; }; /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ @@ -91586,7 +98044,10 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ image_version?: string | null; }; }; @@ -92076,7 +98537,10 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; - /** @description The identifier of a hosted compute network configuration. */ + /** + * @nullable + * @description The identifier of a hosted compute network configuration. + */ network_configuration_id?: string | null; }; }; @@ -92742,7 +99206,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -94183,7 +100650,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; @@ -94877,7 +101347,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -97426,7 +103899,10 @@ export interface operations { * @enum {string} */ action: "approve" | "deny"; - /** @description Reason for approving or denying the requests. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the requests. Max 1024 characters. + */ reason?: string | null; }; }; @@ -97459,7 +103935,10 @@ export interface operations { * @enum {string} */ action: "approve" | "deny"; - /** @description Reason for approving or denying the request. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the request. Max 1024 characters. + */ reason?: string | null; }; }; @@ -97701,9 +104180,15 @@ export interface operations { * @enum {string} */ registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ key_id: string; @@ -97838,9 +104323,15 @@ export interface operations { * @enum {string} */ registry_type?: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; @@ -99362,7 +105853,10 @@ export interface operations { * @enum {string} */ permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ parent_team_id?: number | null; }; }; @@ -100547,6 +107041,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100592,6 +107087,7 @@ export interface operations { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom + * @pattern ^(?:top|bottom|after:\d+)$ */ position: string; /** @@ -100787,6 +107283,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100862,6 +107359,7 @@ export interface operations { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last + * @pattern ^(?:first|last|after:\d+)$ */ position: string; }; @@ -100966,6 +107464,7 @@ export interface operations { */ name?: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -101347,6 +107846,7 @@ export interface operations { */ visibility?: "public" | "private"; /** + * @nullable * @description Specify which security and analysis features to enable or disable for the repository. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -103265,7 +109765,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -104224,7 +110727,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Require status checks to pass before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require status checks to pass before merging. Set to `null` to disable. + */ required_status_checks: { /** @description Require branches to be up to date before merging. */ strict: boolean; @@ -104241,9 +110747,15 @@ export interface operations { app_id?: number; }[]; } | null; - /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ + /** + * @nullable + * @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ enforce_admins: boolean | null; - /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ required_pull_request_reviews: { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { @@ -104275,7 +110787,10 @@ export interface operations { apps?: string[]; }; } | null; - /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ + /** + * @nullable + * @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ restrictions: { /** @description The list of user `login`s with push access */ users: string[]; @@ -104286,7 +110801,10 @@ export interface operations { } | null; /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ required_linear_history?: boolean; - /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + /** + * @nullable + * @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ allow_force_pushes?: boolean | null; /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ allow_deletions?: boolean; @@ -105382,8 +111900,8 @@ export interface operations { */ status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** - * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @@ -105393,8 +111911,8 @@ export interface operations { */ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -105524,8 +112042,8 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ external_id?: string; /** - * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @@ -105540,8 +112058,8 @@ export interface operations { */ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -106560,15 +113078,15 @@ export interface operations { ref: components["schemas"]["code-scanning-ref-full"]; sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** - * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ + * @format uri */ checkout_uri?: string; /** - * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ @@ -106927,6 +113445,7 @@ export interface operations { billable_owner?: components["schemas"]["simple-user"]; defaults?: { location: string; + /** @nullable */ devcontainer_path: string | null; }; }; @@ -107075,7 +113594,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -108470,7 +114992,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -108697,6 +115222,7 @@ export interface operations { */ environment?: string; /** + * @nullable * @description Short description of the deployment. * @default */ @@ -109046,7 +115572,10 @@ export interface operations { "application/json": { wait_timer?: components["schemas"]["wait-timer"]; prevent_self_review?: components["schemas"]["prevent-self-review"]; - /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ + /** + * @nullable + * @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + */ reviewers?: { type?: components["schemas"]["deployment-reviewer-type"]; /** @@ -109552,7 +116081,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -109982,8 +116514,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -109994,8 +116526,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email?: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -110259,8 +116791,8 @@ export interface operations { /** @description The email of the author of the tag */ email: string; /** - * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -110341,6 +116873,7 @@ export interface operations { */ type?: "blob" | "tree" | "commit"; /** + * @nullable * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. @@ -111364,14 +117897,20 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ + /** + * @nullable + * @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ + */ assignee?: string | null; + /** @nullable */ milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ labels?: (string | { id?: number; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ @@ -111745,11 +118284,20 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The title of the issue. */ + /** + * @nullable + * @description The title of the issue. + */ title?: (string | number) | null; - /** @description The contents of the issue. */ + /** + * @nullable + * @description The contents of the issue. + */ body?: string | null; - /** @description Username to assign to this issue. **This field is closing down.** */ + /** + * @nullable + * @description Username to assign to this issue. **This field is closing down.** + */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -111757,17 +118305,21 @@ export interface operations { */ state?: "open" | "closed"; /** + * @nullable * @description The reason for the state change. Ignored unless `state` is changed. * @example not_planned * @enum {string|null} */ state_reason?: "completed" | "not_planned" | "reopened" | null; + /** @nullable */ milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ labels?: (string | { id?: number; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ @@ -113073,8 +119625,8 @@ export interface operations { /** @description A description of the milestone. */ description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on?: string; }; @@ -113178,8 +119730,8 @@ export interface operations { /** @description A description of the milestone. */ description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on?: string; }; @@ -113285,8 +119837,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at?: string; }; @@ -113355,7 +119907,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ + /** + * @nullable + * @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." + */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -113981,9 +120536,9 @@ export interface operations { /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ head: string; /** - * Format: repo.nwo * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. * @example octo-org/octo-repo + * @format repo.nwo */ head_repo?: string; /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ @@ -113995,9 +120550,9 @@ export interface operations { /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ draft?: boolean; /** - * Format: int64 * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. * @example 1 + * @format int64 */ issue?: number; }; @@ -116844,12 +123399,16 @@ export interface operations { */ state: "error" | "failure" | "pending" | "success"; /** + * @nullable * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; - /** @description A short description of the status. */ + /** + * @nullable + * @description A short description of the status. + */ description?: string | null; /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. @@ -117915,7 +124474,10 @@ export interface operations { * @enum {string} */ permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ parent_team_id?: number | null; }; }; @@ -118999,6 +125561,7 @@ export interface operations { */ blog?: string; /** + * @nullable * @description The new Twitter username of the user. * @example therealomarj */ @@ -119358,7 +125921,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -120489,7 +127055,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. */ + /** + * @description The public SSH key to add to your GitHub account. + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) + */ key: string; }; }; @@ -121228,6 +127797,7 @@ export interface operations { */ name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -121720,7 +128290,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** + * @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com + */ key: string; }; }; diff --git a/packages/openapi-fetch/test/examples/schemas/stripe.d.ts b/packages/openapi-fetch/test/examples/schemas/stripe.d.ts index 934a34ee5..b84fcdabd 100644 --- a/packages/openapi-fetch/test/examples/schemas/stripe.d.ts +++ b/packages/openapi-fetch/test/examples/schemas/stripe.d.ts @@ -8856,9 +8856,13 @@ export interface components { * to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). */ account: { - /** @description Business information about the account. */ + /** + * @nullable + * @description Business information about the account. + */ business_profile?: components["schemas"]["account_business_profile"] | null; /** + * @nullable * @description The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. * @enum {string|null} */ @@ -8871,15 +8875,18 @@ export interface components { /** @description The account's country. */ country?: string; /** - * Format: unix-time * @description Time at which the account was connected. Measured in seconds since the Unix epoch. + * @format unix-time */ created?: number; /** @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). */ default_currency?: string; /** @description Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details. */ details_submitted?: boolean; - /** @description An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. */ + /** + * @nullable + * @description An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. + */ email?: string | null; /** * ExternalAccountList @@ -8899,7 +8906,10 @@ export interface components { url: string; }; future_requirements?: components["schemas"]["account_future_requirements"]; - /** @description The groups associated with the account. */ + /** + * @nullable + * @description The groups associated with the account. + */ groups?: components["schemas"]["account_group_membership"] | null; /** @description Unique identifier for the object. */ id: string; @@ -8916,7 +8926,10 @@ export interface components { /** @description Whether the funds in this account can be paid out. */ payouts_enabled?: boolean; requirements?: components["schemas"]["account_requirements"]; - /** @description Options for customizing how the account functions within Stripe. */ + /** + * @nullable + * @description Options for customizing how the account functions within Stripe. + */ settings?: components["schemas"]["account_settings"] | null; tos_acceptance?: components["schemas"]["account_tos_acceptance"]; /** @@ -8927,56 +8940,111 @@ export interface components { }; /** AccountAnnualRevenue */ account_annual_revenue: { - /** @description A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). */ + /** + * @nullable + * @description A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). + */ amount?: number | null; /** - * Format: currency + * @nullable * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string | null; - /** @description The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. */ + /** + * @nullable + * @description The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. + */ fiscal_year_end?: string | null; }; /** AccountBacsDebitPaymentsSettings */ account_bacs_debit_payments_settings: { - /** @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. + */ icon?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. + */ logo?: (string | components["schemas"]["file"]) | null; - /** @description A CSS hex color value representing the primary branding color for this account */ + /** + * @nullable + * @description A CSS hex color value representing the primary branding color for this account + */ primary_color?: string | null; - /** @description A CSS hex color value representing the secondary branding color for this account */ + /** + * @nullable + * @description A CSS hex color value representing the secondary branding color for this account + */ secondary_color?: string | null; }; /** AccountBusinessProfile */ account_business_profile: { - /** @description The applicant's gross annual revenue for its preceding fiscal year. */ + /** + * @nullable + * @description The applicant's gross annual revenue for its preceding fiscal year. + */ annual_revenue?: components["schemas"]["account_annual_revenue"] | null; - /** @description An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. */ + /** + * @nullable + * @description An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. + */ estimated_worker_count?: number | null; - /** @description [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ + /** + * @nullable + * @description [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. + */ mcc?: string | null; monthly_estimated_revenue?: components["schemas"]["account_monthly_estimated_revenue"]; - /** @description The customer-facing business name. */ + /** + * @nullable + * @description The customer-facing business name. + */ name?: string | null; - /** @description Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. */ + /** + * @nullable + * @description Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. + */ product_description?: string | null; - /** @description A publicly available mailing address for sending support issues to. */ + /** + * @nullable + * @description A publicly available mailing address for sending support issues to. + */ support_address?: components["schemas"]["address"] | null; - /** @description A publicly available email address for sending support issues to. */ + /** + * @nullable + * @description A publicly available email address for sending support issues to. + */ support_email?: string | null; - /** @description A publicly available phone number to call with support issues. */ + /** + * @nullable + * @description A publicly available phone number to call with support issues. + */ support_phone?: string | null; - /** @description A publicly available website for handling support issues. */ + /** + * @nullable + * @description A publicly available website for handling support issues. + */ support_url?: string | null; - /** @description The business's publicly available website. */ + /** + * @nullable + * @description The business's publicly available website. + */ url?: string | null; }; /** AccountCapabilities */ @@ -9254,16 +9322,21 @@ export interface components { }; /** AccountCapabilityFutureRequirements */ account_capability_future_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** - * Format: unix-time + * @nullable * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning. + * @format unix-time */ current_deadline?: number | null; /** @description Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ currently_due: string[]; /** + * @nullable * @description This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account. * @enum {string|null} */ @@ -9279,16 +9352,21 @@ export interface components { }; /** AccountCapabilityRequirements */ account_capability_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** - * Format: unix-time + * @nullable * @description Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected. + * @format unix-time */ current_deadline?: number | null; /** @description Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. */ currently_due: string[]; /** + * @nullable * @description Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). * @enum {string|null} */ @@ -9309,18 +9387,33 @@ export interface components { /** AccountCardPaymentsSettings */ account_card_payments_settings: { decline_on?: components["schemas"]["account_decline_charge_on"]; - /** @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. */ + /** + * @nullable + * @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. + */ statement_descriptor_prefix?: string | null; - /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. */ + /** + * @nullable + * @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. + */ statement_descriptor_prefix_kana?: string | null; - /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. */ + /** + * @nullable + * @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. + */ statement_descriptor_prefix_kanji?: string | null; }; /** AccountDashboardSettings */ account_dashboard_settings: { - /** @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ + /** + * @nullable + * @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. + */ display_name?: string | null; - /** @description The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). */ + /** + * @nullable + * @description The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). + */ timezone?: string | null; }; /** AccountDeclineChargeOn */ @@ -9332,37 +9425,63 @@ export interface components { }; /** AccountFutureRequirements */ account_future_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** - * Format: unix-time + * @nullable * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. + * @format unix-time */ 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. */ + /** + * @nullable + * @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; /** + * @nullable * @description This is typed as an enum for consistency with `requirements.disabled_reason`. * @enum {string|null} */ disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** + * @nullable + * @description Fields that are `currently_due` and need to be collected again because validation or verification failed. + */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ + /** + * @nullable + * @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. + */ eventually_due?: string[] | null; - /** @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ + /** + * @nullable + * @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. + */ past_due?: string[] | null; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** + * @nullable + * @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. + */ pending_verification?: string[] | null; }; /** AccountGroupMembership */ account_group_membership: { - /** @description The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. */ + /** + * @nullable + * @description The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. + */ payments_pricing?: string | null; }; /** AccountInvoicesSettings */ account_invoices_settings: { - /** @description The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. */ + /** + * @nullable + * @description The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. + */ default_account_tax_ids?: (string | components["schemas"]["tax_id"])[] | null; }; /** @@ -9374,13 +9493,13 @@ export interface components { */ account_link: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time * @description The timestamp at which this account link will expire. + * @format unix-time */ expires_at: number; /** @@ -9396,22 +9515,37 @@ export interface components { /** @description A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; }; /** AccountPaymentsSettings */ account_payments_settings: { - /** @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. */ + /** + * @nullable + * @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. + */ statement_descriptor?: string | null; - /** @description The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /** + * @nullable + * @description The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + */ statement_descriptor_kana?: string | null; - /** @description The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /** + * @nullable + * @description The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + */ statement_descriptor_kanji?: string | null; - /** @description The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /** + * @nullable + * @description The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + */ statement_descriptor_prefix_kana?: string | null; - /** @description The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /** + * @nullable + * @description The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + */ statement_descriptor_prefix_kanji?: string | null; }; /** AccountPayoutSettings */ @@ -9419,32 +9553,55 @@ export interface components { /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`. */ debit_negative_balances: boolean; schedule: components["schemas"]["transfer_schedule"]; - /** @description The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. */ + /** + * @nullable + * @description The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. + */ statement_descriptor?: string | null; }; /** AccountRequirements */ account_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** - * Format: unix-time + * @nullable * @description Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. + * @format unix-time */ 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. */ + /** + * @nullable + * @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; /** + * @nullable * @description If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). * @enum {string|null} */ disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** + * @nullable + * @description Fields that are `currently_due` and need to be collected again because validation or verification failed. + */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ + /** + * @nullable + * @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. + */ eventually_due?: string[] | null; - /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ + /** + * @nullable + * @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. + */ past_due?: string[] | null; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** + * @nullable + * @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. + */ pending_verification?: string[] | null; }; /** AccountRequirementsAlternative */ @@ -9494,8 +9651,8 @@ export interface components { client_secret: string; components: components["schemas"]["connect_embedded_account_session_create_components"]; /** - * Format: unix-time * @description The timestamp at which this AccountSession will expire. + * @format unix-time */ expires_at: number; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -9521,9 +9678,15 @@ export interface components { }; /** AccountTermsOfService */ account_terms_of_service: { - /** @description The Unix timestamp marking when the account representative accepted the service agreement. */ + /** + * @nullable + * @description The Unix timestamp marking when the account representative accepted the service agreement. + */ date?: number | null; - /** @description The IP address from which the account representative accepted the service agreement. */ + /** + * @nullable + * @description The IP address from which the account representative accepted the service agreement. + */ ip?: string | null; /** @description The user agent of the browser from which the account representative accepted the service agreement. */ user_agent?: string; @@ -9531,15 +9694,22 @@ export interface components { /** AccountTOSAcceptance */ account_tos_acceptance: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the account representative accepted their service agreement + * @format unix-time */ date?: number | null; - /** @description The IP address from which the account representative accepted their service agreement */ + /** + * @nullable + * @description The IP address from which the account representative accepted their service agreement + */ ip?: string | null; /** @description The user's service agreement type */ service_agreement?: string; - /** @description The user agent of the browser from which the account representative accepted their service agreement */ + /** + * @nullable + * @description The user agent of the browser from which the account representative accepted their service agreement + */ user_agent?: string | null; }; /** AccountTreasurySettings */ @@ -9590,23 +9760,42 @@ export interface components { }; /** Address */ address: { - /** @description City, district, suburb, town, or village. */ + /** + * @nullable + * @description City, district, suburb, town, or village. + */ city?: string | null; - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; - /** @description Address line 1 (e.g., street, PO Box, or company name). */ + /** + * @nullable + * @description Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string | null; - /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + /** + * @nullable + * @description Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ postal_code?: string | null; - /** @description State, county, province, or region. */ + /** + * @nullable + * @description State, county, province, or region. + */ state?: string | null; }; /** amazon_pay_underlying_payment_method_funding_details */ amazon_pay_underlying_payment_method_funding_details: { card?: components["schemas"]["payment_method_details_passthrough_card"]; /** + * @nullable * @description funding type of the underlying payment method. * @enum {string|null} */ @@ -9650,8 +9839,8 @@ export interface components { /** ApplePayDomain */ apple_pay_domain: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; domain_name: string; @@ -9669,7 +9858,10 @@ export interface components { application: { /** @description Unique identifier for the object. */ id: string; - /** @description The name of the application. */ + /** + * @nullable + * @description The name of the application. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -9687,21 +9879,27 @@ export interface components { amount_refunded: number; /** @description ID of the Connect application that earned the fee. */ application: string | components["schemas"]["application"]; - /** @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ + /** + * @nullable + * @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** @description ID of the charge that the application fee was taken from. */ charge: string | components["schemas"]["charge"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description Polymorphic source of the application fee. Includes the ID of the object the application fee was created from. */ + /** + * @nullable + * @description Polymorphic source of the application fee. Includes the ID of the object the application fee was created from. + */ fee_source?: components["schemas"]["platform_earning_fee_source"] | null; /** @description Unique identifier for the object. */ id: string; @@ -9712,7 +9910,10 @@ export interface components { * @enum {string} */ object: "application_fee"; - /** @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ + /** + * @nullable + * @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. + */ originating_transaction?: (string | components["schemas"]["charge"]) | null; /** @description Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ refunded: boolean; @@ -9748,15 +9949,16 @@ export interface components { */ "apps.secret": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description If true, indicates that this secret has been deleted */ deleted?: boolean; /** - * Format: unix-time + * @nullable * @description The Unix timestamp for the expiry time of the secret, after which the secret deletes. + * @format unix-time */ expires_at?: number | null; /** @description Unique identifier for the object. */ @@ -9770,22 +9972,30 @@ export interface components { * @enum {string} */ object: "apps.secret"; - /** @description The plaintext secret value to be stored. */ + /** + * @nullable + * @description The plaintext secret value to be stored. + */ payload?: string | null; scope: components["schemas"]["secret_service_resource_scope"]; }; /** AutomaticTax */ automatic_tax: { /** + * @nullable * @description If Stripe disabled automatic tax, this enum describes why. * @enum {string|null} */ disabled_reason?: "finalization_requires_location_inputs" | "finalization_system_error" | null; /** @description Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; /** + * @nullable * @description The status of the most recent automated tax calculation for this invoice. * @enum {string|null} */ @@ -9828,8 +10038,8 @@ export interface components { /** @description Balance amount. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; source_types?: components["schemas"]["balance_amount_by_source_type"]; @@ -9848,8 +10058,8 @@ export interface components { /** @description Balance amount. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Breakdown of balance by destination. */ @@ -9880,23 +10090,29 @@ export interface components { /** @description Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. */ amount: number; /** - * Format: unix-time * @description The date that the transaction's net funds become available in the Stripe balance. + * @format unix-time */ available_on: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. */ + /** + * @nullable + * @description If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. + */ exchange_rate?: number | null; /** @description Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. */ fee: number; @@ -9913,7 +10129,10 @@ export interface components { object: "balance_transaction"; /** @description Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. */ reporting_category: string; - /** @description This transaction relates to the Stripe object. */ + /** + * @nullable + * @description This transaction relates to the Stripe object. + */ source?: (string | components["schemas"]["application_fee"] | components["schemas"]["charge"] | components["schemas"]["connect_collection_transfer"] | components["schemas"]["customer_cash_balance_transaction"] | components["schemas"]["dispute"] | components["schemas"]["fee_refund"] | components["schemas"]["issuing.authorization"] | components["schemas"]["issuing.dispute"] | components["schemas"]["issuing.transaction"] | components["schemas"]["payout"] | components["schemas"]["refund"] | components["schemas"]["reserve_transaction"] | components["schemas"]["tax_deducted_at_source"] | components["schemas"]["topup"] | components["schemas"]["transfer"] | components["schemas"]["transfer_reversal"]) | null; /** @description The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. */ status: string; @@ -9934,38 +10153,71 @@ export interface components { * Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) */ bank_account: { - /** @description The ID of the account that the bank account is associated with. */ + /** + * @nullable + * @description The ID of the account that the bank account is associated with. + */ account?: (string | components["schemas"]["account"]) | null; - /** @description The name of the person or business that owns the bank account. */ + /** + * @nullable + * @description The name of the person or business that owns the bank account. + */ account_holder_name?: string | null; - /** @description The type of entity that holds the account. This can be either `individual` or `company`. */ + /** + * @nullable + * @description The type of entity that holds the account. This can be either `individual` or `company`. + */ account_holder_type?: string | null; - /** @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. */ + /** + * @nullable + * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. + */ account_type?: string | null; - /** @description A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. */ + /** + * @nullable + * @description A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. + */ available_payout_methods?: ("instant" | "standard")[] | null; - /** @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ + /** + * @nullable + * @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). + */ bank_name?: string | null; /** @description Two-letter ISO code representing the country the bank account is located in. */ country: string; /** - * Format: currency * @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. + * @format currency */ currency: string; - /** @description The ID of the customer that the bank account is associated with. */ + /** + * @nullable + * @description The ID of the customer that the bank account is associated with. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description Whether this bank account is the default external account for its currency. */ + /** + * @nullable + * @description Whether this bank account is the default external account for its currency. + */ default_for_currency?: boolean | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. */ + /** + * @nullable + * @description Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. + */ future_requirements?: components["schemas"]["external_account_requirements"] | null; /** @description Unique identifier for the object. */ id: string; /** @description The last four digits of the bank account number. */ last4: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -9974,9 +10226,15 @@ export interface components { * @enum {string} */ object: "bank_account"; - /** @description Information about the requirements for the bank account, including what information needs to be collected. */ + /** + * @nullable + * @description Information about the requirements for the bank account, including what information needs to be collected. + */ requirements?: components["schemas"]["external_account_requirements"] | null; - /** @description The routing transit number for the bank account. */ + /** + * @nullable + * @description The routing transit number for the bank account. + */ routing_number?: string | null; /** * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. @@ -10000,8 +10258,8 @@ export interface components { /** BankConnectionsResourceBalance */ bank_connections_resource_balance: { /** - * Format: unix-time * @description The time that the external institution calculated this balance. Measured in seconds since the Unix epoch. + * @format unix-time */ as_of: number; cash?: components["schemas"]["bank_connections_resource_balance_api_resource_cash_balance"]; @@ -10025,6 +10283,7 @@ export interface components { /** BankConnectionsResourceBalanceAPIResourceCashBalance */ bank_connections_resource_balance_api_resource_cash_balance: { /** + * @nullable * @description The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions. * * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. @@ -10038,6 +10297,7 @@ export interface components { /** BankConnectionsResourceBalanceAPIResourceCreditBalance */ bank_connections_resource_balance_api_resource_credit_balance: { /** + * @nullable * @description The credit that has been used by the account holder. * * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. @@ -10051,13 +10311,14 @@ export interface components { /** BankConnectionsResourceBalanceRefresh */ bank_connections_resource_balance_refresh: { /** - * Format: unix-time * @description The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. + * @format unix-time */ last_attempted_at: number; /** - * Format: unix-time + * @nullable * @description Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. + * @format unix-time */ next_refresh_available_at?: number | null; /** @@ -10068,21 +10329,28 @@ export interface components { }; /** BankConnectionsResourceLinkAccountSessionFilters */ bank_connections_resource_link_account_session_filters: { - /** @description Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`. */ + /** + * @nullable + * @description Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`. + */ account_subcategories?: ("checking" | "credit_card" | "line_of_credit" | "mortgage" | "savings")[] | null; - /** @description List of countries from which to filter accounts. */ + /** + * @nullable + * @description List of countries from which to filter accounts. + */ countries?: string[] | null; }; /** BankConnectionsResourceOwnershipRefresh */ bank_connections_resource_ownership_refresh: { /** - * Format: unix-time * @description The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. + * @format unix-time */ last_attempted_at: number; /** - * Format: unix-time + * @nullable * @description Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. + * @format unix-time */ next_refresh_available_at?: number | null; /** @@ -10096,13 +10364,14 @@ export interface components { /** @description Unique identifier for the object. */ id: string; /** - * Format: unix-time * @description The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. + * @format unix-time */ last_attempted_at: number; /** - * Format: unix-time + * @nullable * @description Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. + * @format unix-time */ next_refresh_available_at?: number | null; /** @@ -10114,13 +10383,15 @@ export interface components { /** BankConnectionsResourceTransactionResourceStatusTransitions */ bank_connections_resource_transaction_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Time at which this transaction posted. Measured in seconds since the Unix epoch. + * @format unix-time */ posted_at?: number | null; /** - * Format: unix-time + * @nullable * @description Time at which this transaction was voided. Measured in seconds since the Unix epoch. + * @format unix-time */ void_at?: number | null; }; @@ -10144,13 +10415,17 @@ export interface components { */ object: "billing.alert"; /** + * @nullable * @description Status of the alert. This can be active, inactive or archived. * @enum {string|null} */ status?: "active" | "archived" | "inactive" | null; /** @description Title of the alert. */ title: string; - /** @description Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter). */ + /** + * @nullable + * @description Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter). + */ usage_threshold?: components["schemas"]["thresholds_resource_usage_threshold_config"] | null; }; /** @@ -10176,19 +10451,25 @@ export interface components { */ "billing.credit_balance_transaction": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description Credit details for this credit balance transaction. Only present if type is `credit`. */ + /** + * @nullable + * @description Credit details for this credit balance transaction. Only present if type is `credit`. + */ credit?: components["schemas"]["billing_credit_grants_resource_balance_credit"] | null; /** @description The credit grant associated with this credit balance transaction. */ credit_grant: string | components["schemas"]["billing.credit_grant"]; - /** @description Debit details for this credit balance transaction. Only present if type is `debit`. */ + /** + * @nullable + * @description Debit details for this credit balance transaction. Only present if type is `debit`. + */ debit?: components["schemas"]["billing_credit_grants_resource_balance_debit"] | null; /** - * Format: unix-time * @description The effective time of this credit balance transaction. + * @format unix-time */ effective_at: number; /** @description Unique identifier for the object. */ @@ -10200,9 +10481,13 @@ export interface components { * @enum {string} */ object: "billing.credit_balance_transaction"; - /** @description ID of the test clock this credit balance transaction belongs to. */ + /** + * @nullable + * @description ID of the test clock this credit balance transaction belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; /** + * @nullable * @description The type of credit balance transaction (credit or debit). * @enum {string|null} */ @@ -10223,20 +10508,22 @@ export interface components { */ category: "paid" | "promotional"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description ID of the customer receiving the billing credits. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; /** - * Format: unix-time + * @nullable * @description The time when the billing credits become effective-when they're eligible for use. + * @format unix-time */ effective_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time when the billing credits expire. If not present, the billing credits don't expire. + * @format unix-time */ expires_at?: number | null; /** @description Unique identifier for the object. */ @@ -10247,23 +10534,30 @@ export interface components { metadata: { [key: string]: string; }; - /** @description A descriptive name shown in dashboard. */ + /** + * @nullable + * @description A descriptive name shown in dashboard. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "billing.credit_grant"; - /** @description ID of the test clock this credit grant belongs to. */ + /** + * @nullable + * @description ID of the test clock this credit grant belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; /** - * Format: unix-time + * @nullable * @description The time when this credit grant was voided. If not present, the credit grant hasn't been voided. + * @format unix-time */ voided_at?: number | null; }; @@ -10275,8 +10569,8 @@ export interface components { */ "billing.meter": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; customer_mapping: components["schemas"]["billing_meter_resource_customer_mapping_settings"]; @@ -10286,6 +10580,7 @@ export interface components { /** @description The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. */ event_name: string; /** + * @nullable * @description The time window to pre-aggregate meter events for, if any. * @enum {string|null} */ @@ -10306,8 +10601,8 @@ export interface components { status: "active" | "inactive"; status_transitions: components["schemas"]["billing_meter_resource_billing_meter_status_transitions"]; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; value_settings: components["schemas"]["billing_meter_resource_billing_meter_value"]; @@ -10318,8 +10613,8 @@ export interface components { */ "billing.meter_event": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The name of the meter event. Corresponds with the `event_name` field on a meter. */ @@ -10338,8 +10633,8 @@ export interface components { [key: string]: string; }; /** - * Format: unix-time * @description The timestamp passed in when creating the event. Measured in seconds since the Unix epoch. + * @format unix-time */ timestamp: number; }; @@ -10348,7 +10643,10 @@ export interface components { * @description A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer. */ "billing.meter_event_adjustment": { - /** @description Specifies which event to cancel. */ + /** + * @nullable + * @description Specifies which event to cancel. + */ cancel?: components["schemas"]["billing_meter_resource_billing_meter_event_adjustment_cancel"] | null; /** @description The name of the meter event. Corresponds with the `event_name` field on a meter. */ event_name: string; @@ -10379,8 +10677,8 @@ export interface components { /** @description Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`. */ aggregated_value: number; /** - * Format: unix-time * @description End timestamp for this event summary (exclusive). Must be aligned with minute boundaries. + * @format unix-time */ end_time: number; /** @description Unique identifier for the object. */ @@ -10395,16 +10693,16 @@ export interface components { */ object: "billing.meter_event_summary"; /** - * Format: unix-time * @description Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries. + * @format unix-time */ start_time: number; }; /** BillingClocksResourceStatusDetailsAdvancingStatusDetails */ billing_clocks_resource_status_details_advancing_status_details: { /** - * Format: unix-time * @description The `frozen_time` that the Test Clock is advancing towards. + * @format unix-time */ target_frozen_time: number; }; @@ -10414,7 +10712,10 @@ export interface components { }; /** BillingCreditGrantsResourceAmount */ billing_credit_grants_resource_amount: { - /** @description The monetary amount. */ + /** + * @nullable + * @description The monetary amount. + */ monetary?: components["schemas"]["billing_credit_grants_resource_monetary_amount"] | null; /** * @description The type of this amount. We currently only support `monetary` billing credits. @@ -10429,7 +10730,10 @@ export interface components { /** BillingCreditGrantsResourceBalanceCredit */ billing_credit_grants_resource_balance_credit: { amount: components["schemas"]["billing_credit_grants_resource_amount"]; - /** @description Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`. */ + /** + * @nullable + * @description Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`. + */ credits_application_invoice_voided?: components["schemas"]["billing_credit_grants_resource_balance_credits_application_invoice_voided"] | null; /** * @description The type of credit transaction. @@ -10454,7 +10758,10 @@ export interface components { /** BillingCreditGrantsResourceBalanceDebit */ billing_credit_grants_resource_balance_debit: { amount: components["schemas"]["billing_credit_grants_resource_amount"]; - /** @description Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`. */ + /** + * @nullable + * @description Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`. + */ credits_applied?: components["schemas"]["billing_credit_grants_resource_balance_credits_applied"] | null; /** * @description The type of debit transaction. @@ -10479,13 +10786,25 @@ export interface components { }; /** billing_details */ billing_details: { - /** @description Billing address. */ + /** + * @nullable + * @description Billing address. + */ address?: components["schemas"]["address"] | null; - /** @description Email address. */ + /** + * @nullable + * @description Email address. + */ email?: string | null; - /** @description Full name. */ + /** + * @nullable + * @description Full name. + */ name?: string | null; - /** @description Billing phone number (including extension). */ + /** + * @nullable + * @description Billing phone number (including extension). + */ phone?: string | null; }; /** BillingMeterResourceAggregationSettings */ @@ -10498,14 +10817,18 @@ export interface components { }; /** BillingMeterResourceBillingMeterEventAdjustmentCancel */ billing_meter_resource_billing_meter_event_adjustment_cancel: { - /** @description Unique identifier for the event. */ + /** + * @nullable + * @description Unique identifier for the event. + */ identifier?: string | null; }; /** BillingMeterResourceBillingMeterStatusTransitions */ billing_meter_resource_billing_meter_status_transitions: { /** - * Format: unix-time + * @nullable * @description The time the meter was deactivated, if any. Measured in seconds since Unix epoch. + * @format unix-time */ deactivated_at?: number | null; }; @@ -10531,15 +10854,21 @@ export interface components { "billing_portal.configuration": { /** @description Whether the configuration is active and can be used to create portal sessions. */ active: boolean; - /** @description ID of the Connect Application that created the configuration. */ + /** + * @nullable + * @description ID of the Connect Application that created the configuration. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; business_profile: components["schemas"]["portal_business_profile"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ + /** + * @nullable + * @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. + */ default_return_url?: string | null; features: components["schemas"]["portal_features"]; /** @description Unique identifier for the object. */ @@ -10549,7 +10878,10 @@ export interface components { /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; login_page: components["schemas"]["portal_login_page"]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -10559,8 +10891,8 @@ export interface components { */ object: "billing_portal.configuration"; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; }; @@ -10585,19 +10917,23 @@ export interface components { /** @description The configuration used by this session, describing the features available. */ configuration: string | components["schemas"]["billing_portal.configuration"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The ID of the customer for this session. */ customer: string; - /** @description Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. */ + /** + * @nullable + * @description Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. + */ flow?: components["schemas"]["portal_flows_flow"] | 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; /** + * @nullable * @description The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. * @enum {string|null} */ @@ -10607,23 +10943,34 @@ export interface components { * @enum {string} */ object: "billing_portal.session"; - /** @description The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ + /** + * @nullable + * @description The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. + */ on_behalf_of?: string | null; - /** @description The URL to redirect customers to when they click on the portal's link to return to your website. */ + /** + * @nullable + * @description The URL to redirect customers to when they click on the portal's link to return to your website. + */ return_url?: string | null; /** @description The short-lived URL of the session that gives customers access to the customer portal. */ url: string; }; /** CancellationDetails */ cancellation_details: { - /** @description Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. */ + /** + * @nullable + * @description Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. + */ comment?: string | null; /** + * @nullable * @description The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. * @enum {string|null} */ feedback?: "customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused" | null; /** + * @nullable * @description Why this subscription was canceled. * @enum {string|null} */ @@ -10649,8 +10996,9 @@ export interface components { /** @description Whether the capability has been requested. */ requested: boolean; /** - * Format: unix-time + * @nullable * @description Time at which the capability was requested. Measured in seconds since the Unix epoch. + * @format unix-time */ requested_at?: number | null; requirements?: components["schemas"]["account_capability_requirements"]; @@ -10669,53 +11017,101 @@ export interface components { * Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards) */ card: { - /** @description The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /** + * @nullable + * @description The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + */ account?: (string | components["schemas"]["account"]) | null; - /** @description City/District/Suburb/Town/Village. */ + /** + * @nullable + * @description City/District/Suburb/Town/Village. + */ address_city?: string | null; - /** @description Billing address country, if provided when creating card. */ + /** + * @nullable + * @description Billing address country, if provided when creating card. + */ address_country?: string | null; - /** @description Address line 1 (Street address/PO Box/Company name). */ + /** + * @nullable + * @description Address line 1 (Street address/PO Box/Company name). + */ address_line1?: string | null; - /** @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ + /** + * @nullable + * @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. + */ address_line1_check?: string | null; - /** @description Address line 2 (Apartment/Suite/Unit/Building). */ + /** + * @nullable + * @description Address line 2 (Apartment/Suite/Unit/Building). + */ address_line2?: string | null; - /** @description State/County/Province/Region. */ + /** + * @nullable + * @description State/County/Province/Region. + */ address_state?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ address_zip?: string | null; - /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ + /** + * @nullable + * @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. + */ address_zip_check?: string | null; /** + * @nullable * @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. * @enum {string|null} */ allow_redisplay?: "always" | "limited" | "unspecified" | null; - /** @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. */ + /** + * @nullable + * @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. + */ available_payout_methods?: ("instant" | "standard")[] | null; /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ brand: string; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; /** - * Format: currency + * @nullable * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + * @format currency */ currency?: string | null; - /** @description The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. */ + /** + * @nullable + * @description The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). */ + /** + * @nullable + * @description If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). + */ cvc_check?: string | null; - /** @description Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /** + * @nullable + * @description Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + */ default_for_currency?: boolean | null; - /** @description (For tokenized numbers only.) The last four digits of the device account number. */ + /** + * @nullable + * @description (For tokenized numbers only.) The last four digits of the device account number. + */ dynamic_last4?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* @@ -10729,11 +11125,17 @@ export interface components { iin?: string; /** @description The last four digits of the card. */ last4: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description Cardholder name. */ + /** + * @nullable + * @description Cardholder name. + */ name?: string | null; networks?: components["schemas"]["token_card_networks"]; /** @@ -10742,13 +11144,20 @@ export interface components { */ object: "card"; /** + * @nullable * @description Status of a card based on the card issuer. * @enum {string|null} */ regulated_status?: "regulated" | "unregulated" | null; - /** @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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; }; /** card_generated_from_payment_method_details */ @@ -10759,9 +11168,15 @@ export interface components { }; /** CardIssuingAccountTermsOfService */ card_issuing_account_terms_of_service: { - /** @description The Unix timestamp marking when the account representative accepted the service agreement. */ + /** + * @nullable + * @description The Unix timestamp marking when the account representative accepted the service agreement. + */ date?: number | null; - /** @description The IP address from which the account representative accepted the service agreement. */ + /** + * @nullable + * @description The IP address from which the account representative accepted the service agreement. + */ ip?: string | null; /** @description The user agent of the browser from which the account representative accepted the service agreement. */ user_agent?: string; @@ -10773,7 +11188,10 @@ export interface components { * @description A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. */ cash_balance: { - /** @description A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** + * @nullable + * @description A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + */ available?: { [key: string]: number; } | null; @@ -10802,46 +11220,82 @@ export interface components { amount_captured: number; /** @description Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ amount_refunded: number; - /** @description ID of the Connect application that created the charge. */ + /** + * @nullable + * @description ID of the Connect application that created the charge. + */ application?: (string | components["schemas"]["application"]) | null; - /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ + /** + * @nullable + * @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. + */ application_fee?: (string | components["schemas"]["application_fee"]) | null; - /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ + /** + * @nullable + * @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. + */ application_fee_amount?: number | null; - /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ + /** + * @nullable + * @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; billing_details: components["schemas"]["billing_details"]; - /** @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. */ + /** + * @nullable + * @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. + */ calculated_statement_descriptor?: string | null; /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ captured: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description ID of the customer this charge is for if one exists. */ + /** + * @nullable + * @description ID of the customer this charge is for if one exists. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description Whether the charge has been disputed. */ disputed: boolean; - /** @description ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. */ + /** + * @nullable + * @description ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. + */ failure_balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; - /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes). */ + /** + * @nullable + * @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes). + */ failure_code?: string | null; - /** @description Message to user further explaining reason for charge failure if available. */ + /** + * @nullable + * @description Message to user further explaining reason for charge failure if available. + */ failure_message?: string | null; - /** @description Information on fraud assessments for the charge. */ + /** + * @nullable + * @description Information on fraud assessments for the charge. + */ fraud_details?: components["schemas"]["charge_fraud_details"] | null; /** @description Unique identifier for the object. */ id: string; - /** @description ID of the invoice this charge is for if one exists. */ + /** + * @nullable + * @description ID of the invoice this charge is for if one exists. + */ invoice?: (string | components["schemas"]["invoice"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -10854,29 +11308,54 @@ export interface components { * @enum {string} */ object: "charge"; - /** @description The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ + /** + * @nullable + * @description The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. */ + /** + * @nullable + * @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. + */ outcome?: components["schemas"]["charge_outcome"] | null; /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ paid: boolean; - /** @description ID of the PaymentIntent associated with this charge, if one exists. */ + /** + * @nullable + * @description ID of the PaymentIntent associated with this charge, if one exists. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; - /** @description ID of the payment method used in this charge. */ + /** + * @nullable + * @description ID of the payment method used in this charge. + */ payment_method?: string | null; - /** @description Details about the payment method at the time of the transaction. */ + /** + * @nullable + * @description Details about the payment method at the time of the transaction. + */ payment_method_details?: components["schemas"]["payment_method_details"] | null; radar_options?: components["schemas"]["radar_radar_options"]; - /** @description This is the email address that the receipt for this charge was sent to. */ + /** + * @nullable + * @description This is the email address that the receipt for this charge was sent to. + */ receipt_email?: string | null; - /** @description This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent. */ + /** + * @nullable + * @description This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent. + */ receipt_number?: string | null; - /** @description This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt. */ + /** + * @nullable + * @description This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt. + */ receipt_url?: string | null; /** @description Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ refunded: boolean; /** * RefundList + * @nullable * @description A list of refunds that have been applied to the charge. */ refunds?: { @@ -10892,19 +11371,32 @@ export interface components { /** @description The URL where this list can be accessed. */ url: string; } | null; - /** @description ID of the review associated with this charge if one exists. */ + /** + * @nullable + * @description ID of the review associated with this charge if one exists. + */ review?: (string | components["schemas"]["review"]) | null; - /** @description Shipping information for the charge. */ + /** + * @nullable + * @description Shipping information for the charge. + */ shipping?: components["schemas"]["shipping"] | null; - /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. */ + /** + * @nullable + * @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. + */ source_transfer?: (string | components["schemas"]["transfer"]) | null; /** + * @nullable * @description For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). * * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. */ statement_descriptor?: string | null; - /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. */ + /** + * @nullable + * @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. + */ statement_descriptor_suffix?: string | null; /** * @description The status of the payment is either `succeeded`, `pending`, or `failed`. @@ -10913,9 +11405,15 @@ export interface components { status: "failed" | "pending" | "succeeded"; /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ transfer?: string | components["schemas"]["transfer"]; - /** @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ + /** + * @nullable + * @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. + */ transfer_data?: components["schemas"]["charge_transfer_data"] | null; - /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /** + * @nullable + * @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. + */ transfer_group?: string | null; }; /** ChargeFraudDetails */ @@ -10928,17 +11426,30 @@ export interface components { /** ChargeOutcome */ charge_outcome: { /** + * @nullable * @description An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines). * @enum {string|null} */ advice_code?: "confirm_card_data" | "do_not_try_again" | "try_again_later" | null; - /** @description For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. */ + /** + * @nullable + * @description For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. + */ network_advice_code?: string | null; - /** @description For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + /** + * @nullable + * @description For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. + */ network_decline_code?: string | null; - /** @description Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. */ + /** + * @nullable + * @description Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. + */ network_status?: string | null; - /** @description An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. */ + /** + * @nullable + * @description An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. + */ reason?: string | null; /** @description Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar. */ risk_level?: string; @@ -10946,14 +11457,20 @@ export interface components { risk_score?: number; /** @description The ID of the Radar rule that matched the payment, if applicable. */ rule?: string | components["schemas"]["rule"]; - /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ + /** + * @nullable + * @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. + */ seller_message?: string | null; /** @description Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details. */ type: string; }; /** ChargeTransferData */ charge_transfer_data: { - /** @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ + /** + * @nullable + * @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. + */ amount?: number | null; /** @description ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ destination: string | components["schemas"]["account"]; @@ -10976,52 +11493,86 @@ export interface components { * Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart) */ "checkout.session": { - /** @description Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). */ + /** + * @nullable + * @description Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). + */ adaptive_pricing?: components["schemas"]["payment_pages_checkout_session_adaptive_pricing"] | null; - /** @description When set, provides configuration for actions to take if this Checkout Session expires. */ + /** + * @nullable + * @description When set, provides configuration for actions to take if this Checkout Session expires. + */ after_expiration?: components["schemas"]["payment_pages_checkout_session_after_expiration"] | null; - /** @description Enables user redeemable promotion codes. */ + /** + * @nullable + * @description Enables user redeemable promotion codes. + */ allow_promotion_codes?: boolean | null; - /** @description Total of all items before discounts or taxes are applied. */ + /** + * @nullable + * @description Total of all items before discounts or taxes are applied. + */ amount_subtotal?: number | null; - /** @description Total of all items after discounts and taxes are applied. */ + /** + * @nullable + * @description Total of all items after discounts and taxes are applied. + */ amount_total?: number | null; automatic_tax: components["schemas"]["payment_pages_checkout_session_automatic_tax"]; /** + * @nullable * @description Describes whether Checkout should collect the customer's billing address. Defaults to `auto`. * @enum {string|null} */ billing_address_collection?: "auto" | "required" | null; - /** @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. */ + /** + * @nullable + * @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. + */ cancel_url?: string | null; /** + * @nullable * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * Session with your internal systems. */ client_reference_id?: string | null; - /** @description Client secret to be used when initializing Stripe.js embedded checkout. */ + /** + * @nullable + * @description Client secret to be used when initializing Stripe.js embedded checkout. + */ client_secret?: string | null; - /** @description Results of `consent_collection` for this session. */ + /** + * @nullable + * @description Results of `consent_collection` for this session. + */ consent?: components["schemas"]["payment_pages_checkout_session_consent"] | null; - /** @description When set, provides configuration for the Checkout Session to gather active consent from customers. */ + /** + * @nullable + * @description When set, provides configuration for the Checkout Session to gather active consent from customers. + */ consent_collection?: components["schemas"]["payment_pages_checkout_session_consent_collection"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency + * @nullable * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string | null; - /** @description Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions */ + /** + * @nullable + * @description Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions + */ currency_conversion?: components["schemas"]["payment_pages_checkout_session_currency_conversion"] | null; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields: components["schemas"]["payment_pages_checkout_session_custom_fields"][]; custom_text: components["schemas"]["payment_pages_checkout_session_custom_text"]; /** + * @nullable * @description The ID of the customer for this Session. * For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout * will create a new customer object based on information provided @@ -11030,13 +11581,18 @@ export interface components { */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** + * @nullable * @description Configure whether a Checkout Session creates a Customer when the Checkout Session completes. * @enum {string|null} */ customer_creation?: "always" | "if_required" | null; - /** @description The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode. */ + /** + * @nullable + * @description The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode. + */ customer_details?: components["schemas"]["payment_pages_checkout_session_customer_details"] | null; /** + * @nullable * @description If provided, this value will be used when the Customer object is created. * If not provided, customers will be asked to enter their email address. * Use this parameter to prefill customer data if you already have an email @@ -11044,18 +11600,27 @@ export interface components { * complete, use the `customer` attribute. */ customer_email?: string | null; - /** @description List of coupons and promotion codes attached to the Checkout Session. */ + /** + * @nullable + * @description List of coupons and promotion codes attached to the Checkout Session. + */ discounts?: components["schemas"]["payment_pages_checkout_session_discount"][] | null; /** - * Format: unix-time * @description The timestamp at which the Checkout Session will expire. + * @format unix-time */ expires_at: number; /** @description Unique identifier for the object. */ id: string; - /** @description ID of the invoice created by the Checkout Session, if it exists. */ + /** + * @nullable + * @description ID of the invoice created by the Checkout Session, if it exists. + */ invoice?: (string | components["schemas"]["invoice"]) | null; - /** @description Details on the state of invoice creation for the Checkout Session. */ + /** + * @nullable + * @description Details on the state of invoice creation for the Checkout Session. + */ invoice_creation?: components["schemas"]["payment_pages_checkout_session_invoice_creation"] | null; /** * PaymentPagesCheckoutSessionListLineItems @@ -11077,11 +11642,15 @@ export interface components { /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; /** + * @nullable * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string|null} */ locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-GB" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW" | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -11095,18 +11664,31 @@ export interface components { * @enum {string} */ object: "checkout.session"; - /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. */ + /** + * @nullable + * @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; - /** @description The ID of the Payment Link that created this Session. */ + /** + * @nullable + * @description The ID of the Payment Link that created this Session. + */ payment_link?: (string | components["schemas"]["payment_link"]) | null; /** + * @nullable * @description Configure whether a Checkout Session should collect a payment method. Defaults to `always`. * @enum {string|null} */ payment_method_collection?: "always" | "if_required" | null; - /** @description Information about the payment method configuration used for this Checkout session if using dynamic payment methods. */ + /** + * @nullable + * @description Information about the payment method configuration used for this Checkout session if using dynamic payment methods. + */ payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; - /** @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ + /** + * @nullable + * @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. + */ payment_method_options?: components["schemas"]["checkout_session_payment_method_options"] | null; /** * @description A list of the types of payment methods (e.g. card) this Checkout @@ -11120,7 +11702,10 @@ export interface components { */ payment_status: "no_payment_required" | "paid" | "unpaid"; phone_number_collection?: components["schemas"]["payment_pages_checkout_session_phone_number_collection"]; - /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ + /** + * @nullable + * @description The ID of the original expired Checkout Session that triggered the recovery flow. + */ recovered_from?: string | null; /** * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. @@ -11129,46 +11714,72 @@ export interface components { redirect_on_completion?: "always" | "if_required" | "never"; /** @description Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. */ return_url?: string; - /** @description Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. */ + /** + * @nullable + * @description Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. + */ saved_payment_method_options?: components["schemas"]["payment_pages_checkout_session_saved_payment_method_options"] | null; - /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. */ + /** + * @nullable + * @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + */ setup_intent?: (string | components["schemas"]["setup_intent"]) | null; - /** @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ + /** + * @nullable + * @description When set, provides configuration for Checkout to collect a shipping address from a customer. + */ shipping_address_collection?: components["schemas"]["payment_pages_checkout_session_shipping_address_collection"] | null; - /** @description The details of the customer cost of shipping, including the customer chosen ShippingRate. */ + /** + * @nullable + * @description The details of the customer cost of shipping, including the customer chosen ShippingRate. + */ shipping_cost?: components["schemas"]["payment_pages_checkout_session_shipping_cost"] | null; - /** @description Shipping information for this Checkout Session. */ + /** + * @nullable + * @description Shipping information for this Checkout Session. + */ shipping_details?: components["schemas"]["shipping"] | null; /** @description The shipping rate options applied to this Session. */ shipping_options: components["schemas"]["payment_pages_checkout_session_shipping_option"][]; /** + * @nullable * @description The status of the Checkout Session, one of `open`, `complete`, or `expired`. * @enum {string|null} */ status?: "complete" | "expired" | "open" | null; /** + * @nullable * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be * specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. * @enum {string|null} */ submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe" | null; - /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ + /** + * @nullable + * @description The ID of the subscription for Checkout Sessions in `subscription` mode. + */ subscription?: (string | components["schemas"]["subscription"]) | null; /** + * @nullable * @description The URL the customer will be directed to after the payment or * subscription creation is successful. */ success_url?: string | null; tax_id_collection?: components["schemas"]["payment_pages_checkout_session_tax_id_collection"]; - /** @description Tax and discount details for the computed total amount. */ + /** + * @nullable + * @description Tax and discount details for the computed total amount. + */ total_details?: components["schemas"]["payment_pages_checkout_session_total_details"] | null; /** + * @nullable * @description The UI mode of the Session. Defaults to `hosted`. * @enum {string|null} */ ui_mode?: "embedded" | "hosted" | null; /** + * @nullable * @description The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.` * This value is only present when the session is active. */ @@ -11180,14 +11791,19 @@ export interface components { custom_mandate_url?: string; /** @description List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. */ default_for?: ("invoice" | "subscription")[]; - /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /** + * @nullable + * @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. + */ interval_description?: string | null; /** + * @nullable * @description Payment schedule for the mandate. * @enum {string|null} */ payment_schedule?: "combined" | "interval" | "sporadic" | null; /** + * @nullable * @description Transaction type of the mandate. * @enum {string|null} */ @@ -11406,6 +12022,7 @@ export interface components { */ requested_address_types?: ("aba" | "iban" | "sepa" | "sort_code" | "spei" | "swift" | "zengin")[]; /** + * @nullable * @description The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. * @enum {string|null} */ @@ -11415,6 +12032,7 @@ export interface components { checkout_customer_balance_payment_method_options: { bank_transfer?: components["schemas"]["checkout_customer_balance_bank_transfer_payment_method_options"]; /** + * @nullable * @description The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. * @enum {string|null} */ @@ -11536,7 +12154,10 @@ export interface components { }; /** CheckoutKonbiniPaymentMethodOptions */ checkout_konbini_payment_method_options: { - /** @description The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. */ + /** + * @nullable + * @description The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. + */ expires_after_days?: number | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11688,9 +12309,15 @@ export interface components { * @enum {string} */ capture_method?: "manual"; - /** @description Preferred locale of the PayPal checkout page that the customer is redirected to. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. @@ -11706,7 +12333,10 @@ export interface components { }; /** CheckoutPixPaymentMethodOptions */ checkout_pix_payment_method_options: { - /** @description The number of seconds after which Pix payment will expire. */ + /** + * @nullable + * @description The number of seconds after which Pix payment will expire. + */ expires_after_seconds?: number | null; }; /** CheckoutRevolutPayPaymentMethodOptions */ @@ -11802,7 +12432,10 @@ export interface components { }; /** CheckoutSwishPaymentMethodOptions */ checkout_swish_payment_method_options: { - /** @description The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. */ + /** + * @nullable + * @description The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. + */ reference?: string | null; }; /** CheckoutUsBankAccountPaymentMethodOptions */ @@ -11839,37 +12472,45 @@ export interface components { amount_total: number; beneficiary?: components["schemas"]["climate_removals_beneficiary"]; /** - * Format: unix-time + * @nullable * @description Time at which the order was canceled. Measured in seconds since the Unix epoch. + * @format unix-time */ canceled_at?: number | null; /** + * @nullable * @description Reason for the cancellation of this order. * @enum {string|null} */ cancellation_reason?: "expired" | "product_unavailable" | "requested" | null; - /** @description For delivered orders, a URL to a delivery certificate for the order. */ + /** + * @nullable + * @description For delivered orders, a URL to a delivery certificate for the order. + */ certificate?: string | null; /** - * Format: unix-time + * @nullable * @description Time at which the order was confirmed. Measured in seconds since the Unix epoch. + * @format unix-time */ confirmed_at?: number | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order. */ currency: string; /** - * Format: unix-time + * @nullable * @description Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch. + * @format unix-time */ delayed_at?: number | null; /** - * Format: unix-time + * @nullable * @description Time at which the order was delivered. Measured in seconds since the Unix epoch. + * @format unix-time */ delivered_at?: number | null; /** @description Details about the delivery of carbon removal for this order. */ @@ -11885,8 +12526,8 @@ export interface components { [key: string]: string; }; /** - * Format: decimal * @description Quantity of carbon removal that is included in this order. + * @format decimal */ metric_tons: string; /** @@ -11897,8 +12538,9 @@ export interface components { /** @description Unique ID for the Climate `Product` this order is purchasing. */ product: string | components["schemas"]["climate.product"]; /** - * Format: unix-time + * @nullable * @description Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch. + * @format unix-time */ product_substituted_at?: number | null; /** @@ -11914,15 +12556,18 @@ export interface components { */ "climate.product": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Current prices for a metric ton of carbon removal in a currency's smallest unit. */ current_prices_per_metric_ton: { [key: string]: components["schemas"]["climate_removals_products_price"]; }; - /** @description The year in which the carbon removal is expected to be delivered. */ + /** + * @nullable + * @description The year in which the carbon removal is expected to be delivered. + */ delivery_year?: number | null; /** * @description Unique identifier for the object. For convenience, Climate product IDs are human-readable strings @@ -11933,8 +12578,8 @@ export interface components { /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; /** - * Format: decimal * @description The quantity of metric tons available for reservation. + * @format decimal */ metric_tons_available: string; /** @description The Climate product's name. */ @@ -11980,15 +12625,27 @@ export interface components { }; /** ClimateRemovalsLocation */ climate_removals_location: { - /** @description The city where the supplier is located. */ + /** + * @nullable + * @description The city where the supplier is located. + */ city?: string | null; /** @description Two-letter ISO code representing the country where the supplier is located. */ country: string; - /** @description The geographic latitude where the supplier is located. */ + /** + * @nullable + * @description The geographic latitude where the supplier is located. + */ latitude?: number | null; - /** @description The geographic longitude where the supplier is located. */ + /** + * @nullable + * @description The geographic longitude where the supplier is located. + */ longitude?: number | null; - /** @description The state/county/province/region where the supplier is located. */ + /** + * @nullable + * @description The state/county/province/region where the supplier is located. + */ region?: string | null; }; /** @@ -11997,15 +12654,21 @@ export interface components { */ climate_removals_order_deliveries: { /** - * Format: unix-time * @description Time at which the delivery occurred. Measured in seconds since the Unix epoch. + * @format unix-time */ delivered_at: number; - /** @description Specific location of this delivery. */ + /** + * @nullable + * @description Specific location of this delivery. + */ location?: components["schemas"]["climate_removals_location"] | null; /** @description Quantity of carbon removal supplied by this delivery. */ metric_tons: string; - /** @description Once retired, a URL to the registry entry for the tons from this delivery. */ + /** + * @nullable + * @description Once retired, a URL to the registry entry for the tons from this delivery. + */ registry_url?: string | null; supplier: components["schemas"]["climate.supplier"]; }; @@ -12030,44 +12693,67 @@ export interface components { */ confirmation_token: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time + * @nullable * @description Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. + * @format unix-time */ 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 Data used for generating a Mandate. */ + /** + * @nullable + * @description Data used for generating a Mandate. + */ mandate_data?: components["schemas"]["confirmation_tokens_resource_mandate_data"] | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "confirmation_token"; - /** @description ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. */ + /** + * @nullable + * @description ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. + */ payment_intent?: string | null; - /** @description Payment-method-specific configuration for this ConfirmationToken. */ + /** + * @nullable + * @description Payment-method-specific configuration for this ConfirmationToken. + */ payment_method_options?: components["schemas"]["confirmation_tokens_resource_payment_method_options"] | null; - /** @description Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. */ + /** + * @nullable + * @description Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. + */ payment_method_preview?: components["schemas"]["confirmation_tokens_resource_payment_method_preview"] | null; - /** @description Return URL used to confirm the Intent. */ + /** + * @nullable + * @description Return URL used to confirm the Intent. + */ return_url?: string | null; /** + * @nullable * @description Indicates that you intend to make future payments with this ConfirmationToken's payment method. * * The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; - /** @description ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. */ + /** + * @nullable + * @description ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. + */ setup_intent?: string | null; - /** @description Shipping information collected on this ConfirmationToken. */ + /** + * @nullable + * @description Shipping information collected on this ConfirmationToken. + */ shipping?: components["schemas"]["confirmation_tokens_resource_shipping"] | null; /** @description Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken. */ use_stripe_sdk: boolean; @@ -12084,7 +12770,10 @@ export interface components { * @description This hash contains details about the customer acceptance of the Mandate. */ confirmation_tokens_resource_mandate_data_resource_customer_acceptance: { - /** @description If this is a Mandate accepted online, this hash contains details about the online acceptance. */ + /** + * @nullable + * @description If this is a Mandate accepted online, this hash contains details about the online acceptance. + */ online?: components["schemas"]["confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online"] | null; /** @description The type of customer acceptance information included with the Mandate. */ type: string; @@ -12094,9 +12783,15 @@ export interface components { * @description This hash contains details about the online acceptance. */ confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online: { - /** @description The IP address from which the Mandate was accepted by the customer. */ + /** + * @nullable + * @description The IP address from which the Mandate was accepted by the customer. + */ ip_address?: string | null; - /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ + /** + * @nullable + * @description The user agent of the browser from which the Mandate was accepted by the customer. + */ user_agent?: string | null; }; /** @@ -12104,7 +12799,10 @@ export interface components { * @description Payment-method-specific configuration */ confirmation_tokens_resource_payment_method_options: { - /** @description This hash contains the card payment method options. */ + /** + * @nullable + * @description This hash contains the card payment method options. + */ card?: components["schemas"]["confirmation_tokens_resource_payment_method_options_resource_card"] | null; }; /** @@ -12112,7 +12810,10 @@ export interface components { * @description This hash contains the card payment method options. */ confirmation_tokens_resource_payment_method_options_resource_card: { - /** @description The `cvc_update` Token collected from the Payment Element. */ + /** + * @nullable + * @description The `cvc_update` Token collected from the Payment Element. + */ cvc_token?: string | null; }; /** @@ -12140,7 +12841,10 @@ export interface components { card?: components["schemas"]["payment_method_card"]; card_present?: components["schemas"]["payment_method_card_present"]; cashapp?: components["schemas"]["payment_method_cashapp"]; - /** @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. */ + /** + * @nullable + * @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. + */ customer?: (string | components["schemas"]["customer"]) | null; customer_balance?: components["schemas"]["payment_method_customer_balance"]; eps?: components["schemas"]["payment_method_eps"]; @@ -12185,7 +12889,10 @@ export interface components { address: components["schemas"]["address"]; /** @description Recipient name. */ name: string; - /** @description Recipient phone (including extension). */ + /** + * @nullable + * @description Recipient phone (including extension). + */ phone?: string | null; }; /** ConnectAccountReference */ @@ -12203,8 +12910,8 @@ export interface components { /** @description Amount transferred, in cents (or local equivalent). */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description ID of the account that funds are being collected for. */ @@ -12408,17 +13115,21 @@ export interface components { * [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents). */ coupon: { - /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ + /** + * @nullable + * @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. + */ amount_off?: number | null; applies_to?: components["schemas"]["coupon_applies_to"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency + * @nullable * @description If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. + * @format currency */ currency?: string | null; /** @description Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ @@ -12430,30 +13141,46 @@ export interface components { * @enum {string} */ duration: "forever" | "once" | "repeating"; - /** @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ + /** + * @nullable + * @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. + */ duration_in_months?: 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 Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ + /** + * @nullable + * @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. + */ max_redemptions?: number | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ + /** + * @nullable + * @description Name of the coupon displayed to customers on for instance invoices or receipts. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "coupon"; - /** @description Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. */ + /** + * @nullable + * @description Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. + */ percent_off?: number | null; /** - * Format: unix-time + * @nullable * @description Date after which the coupon can no longer be redeemed. + * @format unix-time */ redeem_by?: number | null; /** @description Number of times this coupon has been applied to a customer. */ @@ -12488,26 +13215,30 @@ export interface components { /** @description This is the sum of all the shipping amounts. */ amount_shipping: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description ID of the customer. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; - /** @description Customer balance transaction related to this credit note. */ + /** + * @nullable + * @description Customer balance transaction related to this credit note. + */ customer_balance_transaction?: (string | components["schemas"]["customer_balance_transaction"]) | null; /** @description The integer amount in cents (or local equivalent) representing the total amount of discount that was credited. */ discount_amount: number; /** @description The aggregate amounts calculated per discount for all line items. */ discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; /** - * Format: unix-time + * @nullable * @description The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. + * @format unix-time */ effective_at?: number | null; /** @description Unique identifier for the object. */ @@ -12533,9 +13264,15 @@ export interface components { }; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Customer-facing text that appears on the credit note PDF. */ + /** + * @nullable + * @description Customer-facing text that appears on the credit note PDF. + */ memo?: string | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -12546,20 +13283,30 @@ export interface components { * @enum {string} */ object: "credit_note"; - /** @description Amount that was credited outside of Stripe. */ + /** + * @nullable + * @description Amount that was credited outside of Stripe. + */ out_of_band_amount?: number | null; /** @description The link to download the PDF of the credit note. */ pdf: string; /** @description The pretax credit amounts (ex: discount, credit grants, etc) for all line items. */ pretax_credit_amounts: components["schemas"]["credit_notes_pretax_credit_amount"][]; /** + * @nullable * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string|null} */ reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory" | null; - /** @description Refund related to this credit note. */ + /** + * @nullable + * @description Refund related to this credit note. + */ refund?: (string | components["schemas"]["refund"]) | null; - /** @description The details of the cost of shipping, including the ShippingRate applied to the invoice. */ + /** + * @nullable + * @description The details of the cost of shipping, including the ShippingRate applied to the invoice. + */ shipping_cost?: components["schemas"]["invoices_resource_shipping_cost"] | null; /** * @description Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). @@ -12568,13 +13315,19 @@ export interface components { status: "issued" | "void"; /** @description The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts. */ subtotal: number; - /** @description The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. + */ subtotal_excluding_tax?: number | null; /** @description The aggregate amounts calculated per tax rate for all line items. */ tax_amounts: components["schemas"]["credit_note_tax_amount"][]; /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount. */ total: number; - /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. + */ total_excluding_tax?: number | null; /** * @description Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. @@ -12582,8 +13335,9 @@ export interface components { */ type: "post_payment" | "pre_payment"; /** - * Format: unix-time + * @nullable * @description The time that the credit note was voided. + * @format unix-time */ voided_at?: number | null; }; @@ -12594,9 +13348,15 @@ export interface components { credit_note_line_item: { /** @description The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ amount: number; - /** @description The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. + */ amount_excluding_tax?: number | null; - /** @description Description of the item being credited. */ + /** + * @nullable + * @description Description of the item being credited. + */ description?: string | null; /** @description The integer amount in cents (or local equivalent) representing the discount being credited for this line item. */ discount_amount: number; @@ -12615,7 +13375,10 @@ export interface components { object: "credit_note_line_item"; /** @description The pretax credit amounts (ex: discount, credit grants, etc) for this line item. */ pretax_credit_amounts: components["schemas"]["credit_notes_pretax_credit_amount"][]; - /** @description The number of units of product being credited. */ + /** + * @nullable + * @description The number of units of product being credited. + */ quantity?: number | null; /** @description The amount of tax calculated per tax rate for this line item */ tax_amounts: components["schemas"]["credit_note_tax_amount"][]; @@ -12626,16 +13389,21 @@ export interface components { * @enum {string} */ type: "custom_line_item" | "invoice_line_item"; - /** @description The cost of each unit of product being credited. */ + /** + * @nullable + * @description The cost of each unit of product being credited. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ unit_amount_decimal?: string | null; /** - * Format: decimal + * @nullable * @description The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts. + * @format decimal */ unit_amount_excluding_tax?: string | null; }; @@ -12648,11 +13416,15 @@ export interface components { /** @description The tax rate that was applied to get this tax amount. */ tax_rate: string | components["schemas"]["tax_rate"]; /** + * @nullable * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. * @enum {string|null} */ taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in cents (or local equivalent). */ + /** + * @nullable + * @description The amount on which tax is calculated, in cents (or local equivalent). + */ taxable_amount?: number | null; }; /** CreditNotesPretaxCreditAmount */ @@ -12671,30 +13443,47 @@ export interface components { }; /** CurrencyOption */ currency_option: { - /** @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. */ + /** + * @nullable + * @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. + */ custom_unit_amount?: components["schemas"]["custom_unit_amount"] | null; /** + * @nullable * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string|null} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified" | null; /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: components["schemas"]["price_tier"][]; - /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /** + * @nullable + * @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * @format decimal */ unit_amount_decimal?: string | null; }; /** CustomUnitAmount */ custom_unit_amount: { - /** @description The maximum unit amount the customer can specify for this item. */ + /** + * @nullable + * @description The maximum unit amount the customer can specify for this item. + */ maximum?: number | null; - /** @description The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. */ + /** + * @nullable + * @description The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. + */ minimum?: number | null; - /** @description The starting unit amount which can be updated by the customer. */ + /** + * @nullable + * @description The starting unit amount which can be updated by the customer. + */ preset?: number | null; }; /** @@ -12703,26 +13492,37 @@ export interface components { * and track payments that belong to the same customer. */ customer: { - /** @description The customer's address. */ + /** + * @nullable + * @description The customer's address. + */ address?: components["schemas"]["address"] | null; /** @description The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. */ balance?: number; - /** @description The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically. */ + /** + * @nullable + * @description The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically. + */ cash_balance?: components["schemas"]["cash_balance"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ + /** + * @nullable + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. + */ currency?: string | null; /** + * @nullable * @description ID of the default payment source for the customer. * * If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. */ default_source?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]) | null; /** + * @nullable * @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`. @@ -12730,11 +13530,20 @@ export interface components { * 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. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Describes the current discount active on the customer, if there is one. */ + /** + * @nullable + * @description Describes the current discount active on the customer, if there is one. + */ discount?: components["schemas"]["discount"] | null; - /** @description The customer's email address. */ + /** + * @nullable + * @description The customer's email address. + */ email?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -12742,7 +13551,10 @@ export interface components { invoice_credit_balance?: { [key: string]: number; }; - /** @description The prefix for the customer used to generate unique invoice numbers. */ + /** + * @nullable + * @description The prefix for the customer used to generate unique invoice numbers. + */ invoice_prefix?: string | null; invoice_settings?: components["schemas"]["invoice_setting_customer_setting"]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -12751,7 +13563,10 @@ export interface components { metadata?: { [key: string]: string; }; - /** @description The customer's full name or business name. */ + /** + * @nullable + * @description The customer's full name or business name. + */ name?: string | null; /** @description The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. */ next_invoice_sequence?: number; @@ -12760,11 +13575,20 @@ export interface components { * @enum {string} */ object: "customer"; - /** @description The customer's phone number. */ + /** + * @nullable + * @description The customer's phone number. + */ phone?: string | null; - /** @description The customer's preferred locales (languages), ordered by preference. */ + /** + * @nullable + * @description The customer's preferred locales (languages), ordered by preference. + */ preferred_locales?: string[] | null; - /** @description Mailing and shipping address for the customer. Appears on invoices emailed to this customer. */ + /** + * @nullable + * @description Mailing and shipping address for the customer. Appears on invoices emailed to this customer. + */ shipping?: components["schemas"]["shipping"] | null; /** * ApmsSourcesSourceList @@ -12802,6 +13626,7 @@ export interface components { }; tax?: components["schemas"]["customer_tax"]; /** + * @nullable * @description Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. * @enum {string|null} */ @@ -12823,14 +13648,18 @@ export interface components { /** @description The URL where this list can be accessed. */ url: string; }; - /** @description ID of the test clock that this customer belongs to. */ + /** + * @nullable + * @description ID of the test clock that this customer belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; }; /** customer_acceptance */ customer_acceptance: { /** - * Format: unix-time + * @nullable * @description The time that the customer accepts the mandate. + * @format unix-time */ accepted_at?: number | null; offline?: components["schemas"]["offline_acceptance"]; @@ -12872,7 +13701,10 @@ export interface components { eu_bank_transfer?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer"]; gb_bank_transfer?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer"]; jp_bank_transfer?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer"]; - /** @description The user-supplied reference field on the bank transfer. */ + /** + * @nullable + * @description The user-supplied reference field on the bank transfer. + */ reference?: string | null; /** * @description The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. @@ -12883,29 +13715,56 @@ export interface components { }; /** CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer */ customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer: { - /** @description The BIC of the bank of the sender of the funding. */ + /** + * @nullable + * @description The BIC of the bank of the sender of the funding. + */ bic?: string | null; - /** @description The last 4 digits of the IBAN of the sender of the funding. */ + /** + * @nullable + * @description The last 4 digits of the IBAN of the sender of the funding. + */ iban_last4?: string | null; - /** @description The full name of the sender, as supplied by the sending bank. */ + /** + * @nullable + * @description The full name of the sender, as supplied by the sending bank. + */ sender_name?: string | null; }; /** CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer */ customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer: { - /** @description The last 4 digits of the account number of the sender of the funding. */ + /** + * @nullable + * @description The last 4 digits of the account number of the sender of the funding. + */ account_number_last4?: string | null; - /** @description The full name of the sender, as supplied by the sending bank. */ + /** + * @nullable + * @description The full name of the sender, as supplied by the sending bank. + */ sender_name?: string | null; - /** @description The sort code of the bank of the sender of the funding */ + /** + * @nullable + * @description The sort code of the bank of the sender of the funding + */ sort_code?: string | null; }; /** CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer */ customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer: { - /** @description The name of the bank of the sender of the funding. */ + /** + * @nullable + * @description The name of the bank of the sender of the funding. + */ sender_bank?: string | null; - /** @description The name of the bank branch of the sender of the funding. */ + /** + * @nullable + * @description The name of the bank branch of the sender of the funding. + */ sender_branch?: string | null; - /** @description The full name of the sender, as supplied by the sending bank. */ + /** + * @nullable + * @description The full name of the sender, as supplied by the sending bank. + */ sender_name?: string | null; }; /** CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer */ @@ -12915,7 +13774,10 @@ export interface components { * @enum {string} */ network?: "ach" | "domestic_wire_us" | "swift"; - /** @description The full name of the sender, as supplied by the sending bank. */ + /** + * @nullable + * @description The full name of the sender, as supplied by the sending bank. + */ sender_name?: string | null; }; /** CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction */ @@ -12946,30 +13808,42 @@ export interface components { /** @description The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The ID of the credit note (if any) related to the transaction. */ + /** + * @nullable + * @description The ID of the credit note (if any) related to the transaction. + */ credit_note?: (string | components["schemas"]["credit_note"]) | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The ID of the customer the transaction belongs to. */ customer: string | components["schemas"]["customer"]; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. */ ending_balance: number; /** @description Unique identifier for the object. */ id: string; - /** @description The ID of the invoice (if any) related to the transaction. */ + /** + * @nullable + * @description The ID of the invoice (if any) related to the transaction. + */ invoice?: (string | components["schemas"]["invoice"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -12995,8 +13869,8 @@ export interface components { adjusted_for_overdraft?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft"]; applied_to_payment?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ 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). */ @@ -13044,15 +13918,15 @@ export interface components { client_secret: string; components?: components["schemas"]["customer_session_resource_components"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The Customer the Customer Session was created for. */ customer: string | components["schemas"]["customer"]; /** - * Format: unix-time * @description The timestamp at which this Customer Session will expire. + * @format unix-time */ expires_at: number; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -13087,7 +13961,10 @@ export interface components { customer_session_resource_components_resource_payment_element: { /** @description Whether the Payment Element is enabled. */ enabled: boolean; - /** @description This hash defines whether the Payment Element supports certain features. */ + /** + * @nullable + * @description This hash defines whether the Payment Element supports certain features. + */ features?: components["schemas"]["customer_session_resource_components_resource_payment_element_resource_features"] | null; }; /** @@ -13106,7 +13983,10 @@ export interface components { * @enum {string} */ payment_method_redisplay: "disabled" | "enabled"; - /** @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. */ + /** + * @nullable + * @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. + */ payment_method_redisplay_limit?: number | null; /** * @description Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`. @@ -13123,6 +14003,7 @@ export interface components { */ payment_method_save: "disabled" | "enabled"; /** + * @nullable * @description When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent. * * When using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation. @@ -13145,9 +14026,15 @@ export interface components { * @enum {string} */ automatic_tax: "failed" | "not_collecting" | "supported" | "unrecognized_location"; - /** @description A recent IP address of the customer used for tax reporting and tax location inference. */ + /** + * @nullable + * @description A recent IP address of the customer used for tax reporting and tax location inference. + */ ip_address?: string | null; - /** @description The customer's location as identified by Stripe Tax. */ + /** + * @nullable + * @description The customer's location as identified by Stripe Tax. + */ location?: components["schemas"]["customer_tax_location"] | null; }; /** CustomerTaxLocation */ @@ -13159,7 +14046,10 @@ export interface components { * @enum {string} */ source: "billing_address" | "ip_address" | "payment_method" | "shipping_destination"; - /** @description The customer's state, county, province, or region as identified by Stripe Tax. */ + /** + * @nullable + * @description The customer's state, county, province, or region as identified by Stripe Tax. + */ state?: string | null; }; /** DeletedAccount */ @@ -13201,7 +14091,10 @@ export interface components { deleted: true; /** @description Unique identifier for the object. */ id: string; - /** @description The name of the application. */ + /** + * @nullable + * @description The name of the application. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -13211,7 +14104,10 @@ export interface components { }; /** DeletedBankAccount */ deleted_bank_account: { - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ + /** + * @nullable + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. + */ currency?: string | null; /** * @description Always true for a deleted object @@ -13228,7 +14124,10 @@ export interface components { }; /** DeletedCard */ deleted_card: { - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ + /** + * @nullable + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. + */ currency?: string | null; /** * @description Always true for a deleted object @@ -13275,10 +14174,16 @@ export interface components { }; /** DeletedDiscount */ deleted_discount: { - /** @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. */ + /** + * @nullable + * @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. + */ checkout_session?: string | null; coupon: components["schemas"]["coupon"]; - /** @description The ID of the customer associated with this discount. */ + /** + * @nullable + * @description The ID of the customer associated with this discount. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** * @description Always true for a deleted object @@ -13287,25 +14192,40 @@ export interface components { deleted: true; /** @description The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. */ id: string; - /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ + /** + * @nullable + * @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. + */ invoice?: string | null; - /** @description The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. */ + /** + * @nullable + * @description The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. + */ invoice_item?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "discount"; - /** @description The promotion code applied to create this discount. */ + /** + * @nullable + * @description The promotion code applied to create this discount. + */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; /** - * Format: unix-time * @description Date that the coupon was applied. + * @format unix-time */ start: number; - /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ + /** + * @nullable + * @description The subscription that this coupon is applied to, if it is applied to a particular subscription. + */ subscription?: string | null; - /** @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. */ + /** + * @nullable + * @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. + */ subscription_item?: string | null; }; /** Polymorphic */ @@ -13562,37 +14482,59 @@ export interface components { * Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) */ discount: { - /** @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. */ + /** + * @nullable + * @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. + */ checkout_session?: string | null; coupon: components["schemas"]["coupon"]; - /** @description The ID of the customer associated with this discount. */ + /** + * @nullable + * @description The ID of the customer associated with this discount. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** - * Format: unix-time + * @nullable * @description If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. + * @format unix-time */ end?: number | null; /** @description The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. */ id: string; - /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ + /** + * @nullable + * @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. + */ invoice?: string | null; - /** @description The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. */ + /** + * @nullable + * @description The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. + */ invoice_item?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "discount"; - /** @description The promotion code applied to create this discount. */ + /** + * @nullable + * @description The promotion code applied to create this discount. + */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; /** - * Format: unix-time * @description Date that the coupon was applied. + * @format unix-time */ start: number; - /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ + /** + * @nullable + * @description The subscription that this coupon is applied to, if it is applied to a particular subscription. + */ subscription?: string | null; - /** @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. */ + /** + * @nullable + * @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. + */ subscription_item?: string | null; }; /** DiscountsResourceDiscountAmount */ @@ -13604,11 +14546,20 @@ export interface components { }; /** DiscountsResourceStackableDiscount */ discounts_resource_stackable_discount: { - /** @description ID of the coupon to create a new discount for. */ + /** + * @nullable + * @description ID of the coupon to create a new discount for. + */ coupon?: (string | components["schemas"]["coupon"]) | null; - /** @description ID of an existing discount on the object (or one of its ancestors) to reuse. */ + /** + * @nullable + * @description ID of an existing discount on the object (or one of its ancestors) to reuse. + */ discount?: (string | components["schemas"]["discount"]) | null; - /** @description ID of the promotion code to create a new discount for. */ + /** + * @nullable + * @description ID of the promotion code to create a new discount for. + */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; }; /** @@ -13627,13 +14578,13 @@ export interface components { /** @description ID of the charge that's disputed. */ charge: string | components["schemas"]["charge"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description List of eligibility types that are included in `enhanced_evidence`. */ @@ -13655,7 +14606,10 @@ export interface components { * @enum {string} */ object: "dispute"; - /** @description ID of the PaymentIntent that's disputed. */ + /** + * @nullable + * @description ID of the PaymentIntent that's disputed. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; payment_method_details?: components["schemas"]["dispute_payment_method_details"]; /** @description Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ @@ -13696,7 +14650,10 @@ export interface components { }; /** DisputeEnhancedEvidenceVisaCompellingEvidence3 */ dispute_enhanced_evidence_visa_compelling_evidence3: { - /** @description Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. */ + /** + * @nullable + * @description Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. + */ disputed_transaction?: components["schemas"]["dispute_visa_compelling_evidence3_disputed_transaction"] | null; /** @description List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission. */ prior_undisputed_transactions: components["schemas"]["dispute_visa_compelling_evidence3_prior_undisputed_transaction"][]; @@ -13708,67 +14665,149 @@ export interface components { }; /** DisputeEvidence */ dispute_evidence: { - /** @description Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. */ + /** + * @nullable + * @description Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. + */ access_activity_log?: string | null; - /** @description The billing address provided by the customer. */ + /** + * @nullable + * @description The billing address provided by the customer. + */ billing_address?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. + */ cancellation_policy?: (string | components["schemas"]["file"]) | null; - /** @description An explanation of how and when the customer was shown your refund policy prior to purchase. */ + /** + * @nullable + * @description An explanation of how and when the customer was shown your refund policy prior to purchase. + */ cancellation_policy_disclosure?: string | null; - /** @description A justification for why the customer's subscription was not canceled. */ + /** + * @nullable + * @description A justification for why the customer's subscription was not canceled. + */ cancellation_rebuttal?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. + */ customer_communication?: (string | components["schemas"]["file"]) | null; - /** @description The email address of the customer. */ + /** + * @nullable + * @description The email address of the customer. + */ customer_email_address?: string | null; - /** @description The name of the customer. */ + /** + * @nullable + * @description The name of the customer. + */ customer_name?: string | null; - /** @description The IP address that the customer used when making the purchase. */ + /** + * @nullable + * @description The IP address that the customer used when making the purchase. + */ customer_purchase_ip?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. + */ customer_signature?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. + */ duplicate_charge_documentation?: (string | components["schemas"]["file"]) | null; - /** @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ + /** + * @nullable + * @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. + */ duplicate_charge_explanation?: string | null; - /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ + /** + * @nullable + * @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. + */ duplicate_charge_id?: string | null; enhanced_evidence: components["schemas"]["dispute_enhanced_evidence"]; - /** @description A description of the product or service that was sold. */ + /** + * @nullable + * @description A description of the product or service that was sold. + */ product_description?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. + */ receipt?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. + */ refund_policy?: (string | components["schemas"]["file"]) | null; - /** @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ + /** + * @nullable + * @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. + */ refund_policy_disclosure?: string | null; - /** @description A justification for why the customer is not entitled to a refund. */ + /** + * @nullable + * @description A justification for why the customer is not entitled to a refund. + */ refund_refusal_explanation?: string | null; - /** @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ + /** + * @nullable + * @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. + */ service_date?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. + */ service_documentation?: (string | components["schemas"]["file"]) | null; - /** @description The address to which a physical product was shipped. You should try to include as complete address information as possible. */ + /** + * @nullable + * @description The address to which a physical product was shipped. You should try to include as complete address information as possible. + */ shipping_address?: string | null; - /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. */ + /** + * @nullable + * @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. + */ shipping_carrier?: string | null; - /** @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ + /** + * @nullable + * @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. + */ shipping_date?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. + */ shipping_documentation?: (string | components["schemas"]["file"]) | null; - /** @description The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. */ + /** + * @nullable + * @description The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. + */ shipping_tracking_number?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. + */ uncategorized_file?: (string | components["schemas"]["file"]) | null; - /** @description Any additional evidence or statements. */ + /** + * @nullable + * @description Any additional evidence or statements. + */ uncategorized_text?: string | null; }; /** DisputeEvidenceDetails */ dispute_evidence_details: { /** - * Format: unix-time + * @nullable * @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute. + * @format unix-time */ due_by?: number | null; enhanced_eligibility: components["schemas"]["dispute_enhanced_eligibility"]; @@ -13794,6 +14833,7 @@ export interface components { /** DisputePaymentMethodDetailsAmazonPay */ dispute_payment_method_details_amazon_pay: { /** + * @nullable * @description The AmazonPay dispute type, chargeback or claim * @enum {string|null} */ @@ -13808,82 +14848,155 @@ export interface components { * @enum {string} */ case_type: "chargeback" | "inquiry"; - /** @description The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network. */ + /** + * @nullable + * @description The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network. + */ network_reason_code?: string | null; }; /** DisputePaymentMethodDetailsKlarna */ dispute_payment_method_details_klarna: { - /** @description The reason for the dispute as defined by Klarna */ + /** + * @nullable + * @description The reason for the dispute as defined by Klarna + */ reason_code?: string | null; }; /** DisputePaymentMethodDetailsPaypal */ dispute_payment_method_details_paypal: { - /** @description The ID of the dispute in PayPal. */ + /** + * @nullable + * @description The ID of the dispute in PayPal. + */ case_id?: string | null; - /** @description The reason for the dispute as defined by PayPal */ + /** + * @nullable + * @description The reason for the dispute as defined by PayPal + */ reason_code?: string | null; }; /** DisputeTransactionShippingAddress */ dispute_transaction_shipping_address: { - /** @description City, district, suburb, town, or village. */ + /** + * @nullable + * @description City, district, suburb, town, or village. + */ city?: string | null; - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; - /** @description Address line 1 (e.g., street, PO Box, or company name). */ + /** + * @nullable + * @description Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string | null; - /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + /** + * @nullable + * @description Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ postal_code?: string | null; - /** @description State, county, province, or region. */ + /** + * @nullable + * @description State, county, province, or region. + */ state?: string | null; }; /** DisputeVisaCompellingEvidence3DisputedTransaction */ dispute_visa_compelling_evidence3_disputed_transaction: { - /** @description User Account ID used to log into business platform. Must be recognizable by the user. */ + /** + * @nullable + * @description User Account ID used to log into business platform. Must be recognizable by the user. + */ customer_account_id?: string | null; - /** @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. */ + /** + * @nullable + * @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. + */ customer_device_fingerprint?: string | null; - /** @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. */ + /** + * @nullable + * @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. + */ customer_device_id?: string | null; - /** @description The email address of the customer. */ + /** + * @nullable + * @description The email address of the customer. + */ customer_email_address?: string | null; - /** @description The IP address that the customer used when making the purchase. */ + /** + * @nullable + * @description The IP address that the customer used when making the purchase. + */ customer_purchase_ip?: string | null; /** + * @nullable * @description Categorization of disputed payment. * @enum {string|null} */ merchandise_or_services?: "merchandise" | "services" | null; - /** @description A description of the product or service that was sold. */ + /** + * @nullable + * @description A description of the product or service that was sold. + */ product_description?: string | null; - /** @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. */ + /** + * @nullable + * @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. + */ shipping_address?: components["schemas"]["dispute_transaction_shipping_address"] | null; }; /** DisputeVisaCompellingEvidence3PriorUndisputedTransaction */ dispute_visa_compelling_evidence3_prior_undisputed_transaction: { /** @description Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge. */ charge: string; - /** @description User Account ID used to log into business platform. Must be recognizable by the user. */ + /** + * @nullable + * @description User Account ID used to log into business platform. Must be recognizable by the user. + */ customer_account_id?: string | null; - /** @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. */ + /** + * @nullable + * @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. + */ customer_device_fingerprint?: string | null; - /** @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. */ + /** + * @nullable + * @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. + */ customer_device_id?: string | null; - /** @description The email address of the customer. */ + /** + * @nullable + * @description The email address of the customer. + */ customer_email_address?: string | null; - /** @description The IP address that the customer used when making the purchase. */ + /** + * @nullable + * @description The IP address that the customer used when making the purchase. + */ customer_purchase_ip?: string | null; - /** @description A description of the product or service that was sold. */ + /** + * @nullable + * @description A description of the product or service that was sold. + */ product_description?: string | null; - /** @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. */ + /** + * @nullable + * @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. + */ shipping_address?: components["schemas"]["dispute_transaction_shipping_address"] | null; }; /** EmailSent */ email_sent: { /** - * Format: unix-time * @description The timestamp when the email was sent. + * @format unix-time */ email_sent_at: number; /** @description The recipient's email address. */ @@ -13937,13 +15050,13 @@ export interface components { /** EphemeralKey */ ephemeral_key: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time * @description Time at which the key will expire. Measured in seconds since the Unix epoch. + * @format unix-time */ expires: number; /** @description Unique identifier for the object. */ @@ -13998,11 +15111,14 @@ export interface components { event: { /** @description The connected account that originates the event. */ account?: string; - /** @description The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. */ + /** + * @nullable + * @description The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. + */ api_version?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; data: components["schemas"]["notification_event_data"]; @@ -14017,7 +15133,10 @@ export interface components { object: "event"; /** @description Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify. */ pending_webhooks: number; - /** @description Information on the API request that triggers the event. */ + /** + * @nullable + * @description Information on the API request that triggers the event. + */ request?: components["schemas"]["notification_event_request"] | null; /** @description Description of the event (for example, `invoice.created` or `charge.refunded`). */ type: string; @@ -14068,27 +15187,45 @@ export interface components { external_account: components["schemas"]["bank_account"] | components["schemas"]["card"]; /** ExternalAccountRequirements */ external_account_requirements: { - /** @description Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ + /** + * @nullable + * @description Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. + */ currently_due?: string[] | null; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** + * @nullable + * @description Fields that are `currently_due` and need to be collected again because validation or verification failed. + */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. */ + /** + * @nullable + * @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. + */ past_due?: string[] | null; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** + * @nullable + * @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. + */ pending_verification?: string[] | null; }; /** Fee */ fee: { /** @description Amount of the fee, in cents. */ amount: number; - /** @description ID of the Connect application that earned the fee. */ + /** + * @nullable + * @description ID of the Connect application that earned the fee. + */ application?: string | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`. */ type: string; @@ -14104,23 +15241,29 @@ export interface components { fee_refund: { /** @description Amount, in cents (or local equivalent). */ amount: number; - /** @description Balance transaction that describes the impact on your account balance. */ + /** + * @nullable + * @description Balance transaction that describes the impact on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description ID of the application fee that was refunded. */ fee: string | components["schemas"]["application_fee"]; /** @description Unique identifier for the object. */ id: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -14142,21 +15285,26 @@ export interface components { */ file: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time + * @nullable * @description The file expires and isn't available at this time in epoch seconds. + * @format unix-time */ expires_at?: number | null; - /** @description The suitable name for saving the file to a filesystem. */ + /** + * @nullable + * @description The suitable name for saving the file to a filesystem. + */ filename?: string | null; /** @description Unique identifier for the object. */ id: string; /** * FileResourceFileLinkList + * @nullable * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ links?: { @@ -14169,7 +15317,10 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/file_links + */ url: string; } | null; /** @@ -14184,11 +15335,20 @@ export interface components { purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "financial_account_statement" | "identity_document" | "identity_document_downloadable" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; /** @description The size of the file object in bytes. */ size: number; - /** @description A suitable title for the document. */ + /** + * @nullable + * @description A suitable title for the document. + */ title?: string | null; - /** @description The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). */ + /** + * @nullable + * @description The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). + */ type?: string | null; - /** @description Use your live secret API key to download the file from this URL. */ + /** + * @nullable + * @description Use your live secret API key to download the file from this URL. + */ url?: string | null; }; /** @@ -14199,15 +15359,16 @@ export interface components { */ file_link: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Returns if the link is already expired. */ expired: boolean; /** - * Format: unix-time + * @nullable * @description Time that the link expires. + * @format unix-time */ expires_at?: number | null; /** @description The file object this link points to. */ @@ -14225,7 +15386,10 @@ export interface components { * @enum {string} */ object: "file_link"; - /** @description The publicly accessible URL to download the file. */ + /** + * @nullable + * @description The publicly accessible URL to download the file. + */ url?: string | null; }; /** @@ -14233,11 +15397,20 @@ export interface components { * @description A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access. */ "financial_connections.account": { - /** @description The account holder that this account belongs to. */ + /** + * @nullable + * @description The account holder that this account belongs to. + */ account_holder?: components["schemas"]["bank_connections_resource_accountholder"] | null; - /** @description The most recent information about the account's balance. */ + /** + * @nullable + * @description The most recent information about the account's balance. + */ balance?: components["schemas"]["bank_connections_resource_balance"] | null; - /** @description The state of the most recent attempt to refresh the account balance. */ + /** + * @nullable + * @description The state of the most recent attempt to refresh the account balance. + */ balance_refresh?: components["schemas"]["bank_connections_resource_balance_refresh"] | null; /** * @description The type of the account. Account category is further divided in `subcategory`. @@ -14245,17 +15418,23 @@ export interface components { */ category: "cash" | "credit" | "investment" | "other"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description A human-readable name that has been assigned to this account, either by the account holder or by the institution. */ + /** + * @nullable + * @description A human-readable name that has been assigned to this account, either by the account holder or by the institution. + */ display_name?: string | null; /** @description Unique identifier for the object. */ id: string; /** @description The name of the institution that holds this account. */ institution_name: string; - /** @description The last 4 digits of the account number. If present, this will be 4 numeric characters. */ + /** + * @nullable + * @description The last 4 digits of the account number. If present, this will be 4 numeric characters. + */ last4?: string | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -14264,11 +15443,20 @@ export interface components { * @enum {string} */ object: "financial_connections.account"; - /** @description The most recent information about the account's owners. */ + /** + * @nullable + * @description The most recent information about the account's owners. + */ ownership?: (string | components["schemas"]["financial_connections.account_ownership"]) | null; - /** @description The state of the most recent attempt to refresh the account owners. */ + /** + * @nullable + * @description The state of the most recent attempt to refresh the account owners. + */ ownership_refresh?: components["schemas"]["bank_connections_resource_ownership_refresh"] | null; - /** @description The list of permissions granted by this account. */ + /** + * @nullable + * @description The list of permissions granted by this account. + */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[] | null; /** * @description The status of the link to the account. @@ -14293,11 +15481,17 @@ export interface components { * @enum {string} */ subcategory: "checking" | "credit_card" | "line_of_credit" | "mortgage" | "other" | "savings"; - /** @description The list of data refresh subscriptions requested on this account. */ + /** + * @nullable + * @description The list of data refresh subscriptions requested on this account. + */ subscriptions?: "transactions"[] | null; /** @description The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. */ supported_payment_method_types: ("link" | "us_bank_account")[]; - /** @description The state of the most recent attempt to refresh the account transactions. */ + /** + * @nullable + * @description The state of the most recent attempt to refresh the account transactions. + */ transaction_refresh?: components["schemas"]["bank_connections_resource_transaction_refresh"] | null; }; /** @@ -14305,7 +15499,10 @@ export interface components { * @description Describes an owner of an account. */ "financial_connections.account_owner": { - /** @description The email address of the owner. */ + /** + * @nullable + * @description The email address of the owner. + */ email?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -14318,13 +15515,20 @@ export interface components { object: "financial_connections.account_owner"; /** @description The ownership object that this owner belongs to. */ ownership: string; - /** @description The raw phone number of the owner. */ + /** + * @nullable + * @description The raw phone number of the owner. + */ phone?: string | null; - /** @description The raw physical address of the owner. */ + /** + * @nullable + * @description The raw physical address of the owner. + */ raw_address?: string | null; /** - * Format: unix-time + * @nullable * @description The timestamp of the refresh that updated this owner. + * @format unix-time */ refreshed_at?: number | null; }; @@ -14334,8 +15538,8 @@ export interface components { */ "financial_connections.account_ownership": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ @@ -14368,7 +15572,10 @@ export interface components { * @description A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts. */ "financial_connections.session": { - /** @description The account holder for whom accounts are collected in this session. */ + /** + * @nullable + * @description The account holder for whom accounts are collected in this session. + */ account_holder?: components["schemas"]["bank_connections_resource_accountholder"] | null; /** * BankConnectionsResourceLinkedAccountList @@ -14384,7 +15591,10 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/financial_connections/accounts + */ url: string; }; /** @description A value that will be passed to the client to launch the authentication flow. */ @@ -14401,7 +15611,10 @@ export interface components { object: "financial_connections.session"; /** @description Permissions requested for accounts collected during this session. */ permissions: ("balances" | "ownership" | "payment_method" | "transactions")[]; - /** @description Data features requested to be retrieved upon account creation. */ + /** + * @nullable + * @description Data features requested to be retrieved upon account creation. + */ prefetch?: ("balances" | "ownership" | "transactions")[] | null; /** @description For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ return_url?: string; @@ -14435,15 +15648,15 @@ export interface components { status: "pending" | "posted" | "void"; status_transitions: components["schemas"]["bank_connections_resource_transaction_resource_status_transitions"]; /** - * Format: unix-time * @description Time at which the transaction was transacted. Measured in seconds since the Unix epoch. + * @format unix-time */ transacted_at: number; /** @description The token of the transaction refresh that last updated or created this transaction. */ transaction_refresh: string; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; }; @@ -14454,18 +15667,18 @@ export interface components { /** @description Connected account ID by which to filter the report run. */ connected_account?: string; /** - * Format: currency * @description Currency of objects to be included in the report run. + * @format currency */ currency?: string; /** - * Format: unix-time * @description Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value. + * @format unix-time */ interval_end?: number; /** - * Format: unix-time * @description Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value. + * @format unix-time */ interval_start?: number; /** @description Payout ID by which to filter the report run. */ @@ -14543,15 +15756,18 @@ export interface components { */ "forwarding.request": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -14564,13 +15780,25 @@ export interface components { payment_method: string; /** @description The field kinds to be replaced in the forwarded request. */ replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name" | "request_signature")[]; - /** @description Context about the request from Stripe's servers to the destination endpoint. */ + /** + * @nullable + * @description Context about the request from Stripe's servers to the destination endpoint. + */ request_context?: components["schemas"]["forwarded_request_context"] | null; - /** @description The request that was sent to the destination endpoint. We redact any sensitive fields. */ + /** + * @nullable + * @description The request that was sent to the destination endpoint. We redact any sensitive fields. + */ request_details?: components["schemas"]["forwarded_request_details"] | null; - /** @description The response that the destination endpoint returned to us. We redact any sensitive fields. */ + /** + * @nullable + * @description The response that the destination endpoint returned to us. We redact any sensitive fields. + */ response_details?: components["schemas"]["forwarded_response_details"] | null; - /** @description The destination URL for the forwarded request. Must be supported by the config. */ + /** + * @nullable + * @description The destination URL for the forwarded request. Must be supported by the config. + */ url?: string | null; }; /** @@ -14717,20 +15945,41 @@ export interface components { */ funding_instructions_bank_transfer_zengin_record: { account_holder_address: components["schemas"]["address"]; - /** @description The account holder name */ + /** + * @nullable + * @description The account holder name + */ account_holder_name?: string | null; - /** @description The account number */ + /** + * @nullable + * @description The account number + */ account_number?: string | null; - /** @description The bank account type. In Japan, this can only be `futsu` or `toza`. */ + /** + * @nullable + * @description The bank account type. In Japan, this can only be `futsu` or `toza`. + */ account_type?: string | null; bank_address: components["schemas"]["address"]; - /** @description The bank code of the account */ + /** + * @nullable + * @description The bank code of the account + */ bank_code?: string | null; - /** @description The bank name of the account */ + /** + * @nullable + * @description The bank name of the account + */ bank_name?: string | null; - /** @description The branch code of the account */ + /** + * @nullable + * @description The branch code of the account + */ branch_code?: string | null; - /** @description The branch name of the account */ + /** + * @nullable + * @description The branch name of the account + */ branch_name?: string | null; }; /** @@ -14738,11 +15987,20 @@ export interface components { * @description Point in Time */ gelato_data_document_report_date_of_birth: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14750,11 +16008,20 @@ export interface components { * @description Point in Time */ gelato_data_document_report_expiration_date: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14762,11 +16029,20 @@ export interface components { * @description Point in Time */ gelato_data_document_report_issued_date: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14774,11 +16050,20 @@ export interface components { * @description Point in Time */ gelato_data_id_number_report_date: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14786,11 +16071,20 @@ export interface components { * @description Point in Time */ gelato_data_verified_outputs_date: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14798,25 +16092,55 @@ export interface components { * @description Result from a document check */ gelato_document_report: { - /** @description Address as it appears in the document. */ + /** + * @nullable + * @description Address as it appears in the document. + */ address?: components["schemas"]["address"] | null; - /** @description Date of birth as it appears in the document. */ + /** + * @nullable + * @description Date of birth as it appears in the document. + */ dob?: components["schemas"]["gelato_data_document_report_date_of_birth"] | null; - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_document_report_error"] | null; - /** @description Expiration date of the document. */ + /** + * @nullable + * @description Expiration date of the document. + */ expiration_date?: components["schemas"]["gelato_data_document_report_expiration_date"] | null; - /** @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. */ + /** + * @nullable + * @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. + */ files?: string[] | null; - /** @description First name as it appears in the document. */ + /** + * @nullable + * @description First name as it appears in the document. + */ first_name?: string | null; - /** @description Issued date of the document. */ + /** + * @nullable + * @description Issued date of the document. + */ issued_date?: components["schemas"]["gelato_data_document_report_issued_date"] | null; - /** @description Issuing country of the document. */ + /** + * @nullable + * @description Issuing country of the document. + */ issuing_country?: string | null; - /** @description Last name as it appears in the document. */ + /** + * @nullable + * @description Last name as it appears in the document. + */ last_name?: string | null; - /** @description Document ID number. */ + /** + * @nullable + * @description Document ID number. + */ number?: string | null; /** * @description Status of this `document` check. @@ -14824,6 +16148,7 @@ export interface components { */ status: "unverified" | "verified"; /** + * @nullable * @description Type of the document. * @enum {string|null} */ @@ -14832,11 +16157,15 @@ export interface components { /** GelatoDocumentReportError */ gelato_document_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "document_expired" | "document_type_not_supported" | "document_unverified_other" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** @@ -14844,9 +16173,15 @@ export interface components { * @description Result from a email check */ gelato_email_report: { - /** @description Email to be verified. */ + /** + * @nullable + * @description Email to be verified. + */ email?: string | null; - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_email_report_error"] | null; /** * @description Status of this `email` check. @@ -14857,11 +16192,15 @@ export interface components { /** GelatoEmailReportError */ gelato_email_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "email_unverified_other" | "email_verification_declined" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** @@ -14869,20 +16208,36 @@ export interface components { * @description Result from an id_number check */ gelato_id_number_report: { - /** @description Date of birth. */ + /** + * @nullable + * @description Date of birth. + */ dob?: components["schemas"]["gelato_data_id_number_report_date"] | null; - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_id_number_report_error"] | null; - /** @description First name. */ + /** + * @nullable + * @description First name. + */ first_name?: string | null; - /** @description ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present. */ + /** + * @nullable + * @description ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present. + */ id_number?: string | null; /** + * @nullable * @description Type of ID number. * @enum {string|null} */ id_number_type?: "br_cpf" | "sg_nric" | "us_ssn" | null; - /** @description Last name. */ + /** + * @nullable + * @description Last name. + */ last_name?: string | null; /** * @description Status of this `id_number` check. @@ -14893,11 +16248,15 @@ export interface components { /** GelatoIdNumberReportError */ gelato_id_number_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** @@ -14905,9 +16264,15 @@ export interface components { * @description Result from a phone check */ gelato_phone_report: { - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_phone_report_error"] | null; - /** @description Phone to be verified. */ + /** + * @nullable + * @description Phone to be verified. + */ phone?: string | null; /** * @description Status of this `phone` check. @@ -14918,11 +16283,15 @@ export interface components { /** GelatoPhoneReportError */ gelato_phone_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "phone_unverified_other" | "phone_verification_declined" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** GelatoProvidedDetails */ @@ -14950,11 +16319,20 @@ export interface components { * @description Result from a selfie check */ gelato_selfie_report: { - /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. */ + /** + * @nullable + * @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. + */ document?: string | null; - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_selfie_report_error"] | null; - /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. */ + /** + * @nullable + * @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. + */ selfie?: string | null; /** * @description Status of this `selfie` check. @@ -14965,11 +16343,15 @@ export interface components { /** GelatoSelfieReportError */ gelato_selfie_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** GelatoSessionDocumentOptions */ @@ -14996,11 +16378,15 @@ export interface components { */ gelato_session_last_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification or user-session failure. * @enum {string|null} */ code?: "abandoned" | "consent_declined" | "country_not_supported" | "device_not_supported" | "document_expired" | "document_type_not_supported" | "document_unverified_other" | "email_unverified_other" | "email_verification_declined" | "id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other" | "phone_unverified_other" | "phone_verification_declined" | "selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other" | "under_supported_age" | null; - /** @description A message that explains the reason for verification or user-session failure. */ + /** + * @nullable + * @description A message that explains the reason for verification or user-session failure. + */ reason?: string | null; }; /** GelatoSessionPhoneOptions */ @@ -15022,24 +16408,46 @@ export interface components { }; /** GelatoVerifiedOutputs */ gelato_verified_outputs: { - /** @description The user's verified address. */ + /** + * @nullable + * @description The user's verified address. + */ address?: components["schemas"]["address"] | null; - /** @description The user’s verified date of birth. */ + /** + * @nullable + * @description The user’s verified date of birth. + */ dob?: components["schemas"]["gelato_data_verified_outputs_date"] | null; - /** @description The user's verified email address */ + /** + * @nullable + * @description The user's verified email address + */ email?: string | null; - /** @description The user's verified first name. */ + /** + * @nullable + * @description The user's verified first name. + */ first_name?: string | null; - /** @description The user's verified id number. */ + /** + * @nullable + * @description The user's verified id number. + */ id_number?: string | null; /** + * @nullable * @description The user's verified id number type. * @enum {string|null} */ id_number_type?: "br_cpf" | "sg_nric" | "us_ssn" | null; - /** @description The user's verified last name. */ + /** + * @nullable + * @description The user's verified last name. + */ last_name?: string | null; - /** @description The user's verified phone number */ + /** + * @nullable + * @description The user's verified phone number + */ phone?: string | null; }; /** @@ -15057,11 +16465,14 @@ export interface components { * Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). */ "identity.verification_report": { - /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + /** + * @nullable + * @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. + */ client_reference_id?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; document?: components["schemas"]["gelato_document_report"]; @@ -15086,7 +16497,10 @@ export interface components { type: "document" | "id_number" | "verification_flow"; /** @description The configuration token of a verification flow from the dashboard. */ verification_flow?: string; - /** @description ID of the VerificationSession that created this report. */ + /** + * @nullable + * @description ID of the VerificationSession that created this report. + */ verification_session?: string | null; }; /** @@ -15104,20 +16518,32 @@ export interface components { * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) */ "identity.verification_session": { - /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + /** + * @nullable + * @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. + */ client_reference_id?: string | null; - /** @description The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. */ + /** + * @nullable + * @description The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. + */ client_secret?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; - /** @description If present, this property tells you the last error encountered when processing the verification. */ + /** + * @nullable + * @description If present, this property tells you the last error encountered when processing the verification. + */ last_error?: components["schemas"]["gelato_session_last_error"] | null; - /** @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) */ + /** + * @nullable + * @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) + */ last_verification_report?: (string | components["schemas"]["identity.verification_report"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -15130,13 +16556,25 @@ export interface components { * @enum {string} */ object: "identity.verification_session"; - /** @description A set of options for the session’s verification checks. */ + /** + * @nullable + * @description A set of options for the session’s verification checks. + */ options?: components["schemas"]["gelato_verification_session_options"] | null; - /** @description Details provided about the user being verified. These details may be shown to the user. */ + /** + * @nullable + * @description Details provided about the user being verified. These details may be shown to the user. + */ provided_details?: components["schemas"]["gelato_provided_details"] | null; - /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ + /** + * @nullable + * @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. + */ redaction?: components["schemas"]["verification_session_redaction"] | null; - /** @description Token referencing a Customer resource. */ + /** + * @nullable + * @description Token referencing a Customer resource. + */ related_customer?: string | null; /** * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). @@ -15148,11 +16586,17 @@ export interface components { * @enum {string} */ type: "document" | "id_number" | "verification_flow"; - /** @description The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. */ + /** + * @nullable + * @description The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. + */ url?: string | null; /** @description The configuration token of a verification flow from the dashboard. */ verification_flow?: string; - /** @description The user’s verified data. */ + /** + * @nullable + * @description The user’s verified data. + */ verified_outputs?: components["schemas"]["gelato_verified_outputs"] | null; }; /** InboundTransfers */ @@ -15168,20 +16612,31 @@ export interface components { /** inbound_transfers_payment_method_details_us_bank_account */ inbound_transfers_payment_method_details_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; @@ -15190,20 +16645,38 @@ export interface components { * @enum {string} */ network: "ach"; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; }; /** internal_card */ internal_card: { - /** @description Brand of the card used in the transaction */ + /** + * @nullable + * @description Brand of the card used in the transaction + */ brand?: string | null; - /** @description Two-letter ISO code representing the country of the card */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card + */ country?: string | null; - /** @description Two digit number representing the card's expiration month */ + /** + * @nullable + * @description Two digit number representing the card's expiration month + */ exp_month?: number | null; - /** @description Two digit number representing the card's expiration year */ + /** + * @nullable + * @description Two digit number representing the card's expiration year + */ exp_year?: number | null; - /** @description The last 4 digits of the card */ + /** + * @nullable + * @description The last 4 digits of the card + */ last4?: string | null; }; /** @@ -15242,11 +16715,20 @@ export interface components { * Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending) */ invoice: { - /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ + /** + * @nullable + * @description The country of the business associated with this invoice, most often the business creating the invoice. + */ account_country?: string | null; - /** @description The public name of the business associated with this invoice, most often the business creating the invoice. */ + /** + * @nullable + * @description The public name of the business associated with this invoice, most often the business creating the invoice. + */ account_name?: string | null; - /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ + /** + * @nullable + * @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; /** @description Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. */ amount_due: number; @@ -15256,9 +16738,15 @@ export interface components { amount_remaining: number; /** @description This is the sum of all the shipping amounts. */ amount_shipping: number; - /** @description ID of the Connect Application that created the invoice. */ + /** + * @nullable + * @description ID of the Connect Application that created the invoice. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ + /** + * @nullable + * @description The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. + */ application_fee_amount?: number | null; /** @description Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained. */ attempt_count: number; @@ -15268,11 +16756,13 @@ export interface components { auto_advance?: boolean; automatic_tax: components["schemas"]["automatic_tax"]; /** - * Format: unix-time + * @nullable * @description The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized. + * @format unix-time */ automatically_finalizes_at?: number | null; /** + * @nullable * @description Indicates the reason why the invoice was created. * * * `manual`: Unrelated to a subscription, for example, created via the invoice editor. @@ -15285,7 +16775,10 @@ export interface components { * @enum {string|null} */ billing_reason?: "automatic_pending_invoice_item_invoice" | "manual" | "quote_accept" | "subscription" | "subscription_create" | "subscription_cycle" | "subscription_threshold" | "subscription_update" | "upcoming" | null; - /** @description ID of the latest charge generated for this invoice, if any. */ + /** + * @nullable + * @description ID of the latest charge generated for this invoice, if any. + */ charge?: (string | components["schemas"]["charge"]) | null; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. @@ -15293,74 +16786,134 @@ export interface components { */ collection_method: "charge_automatically" | "send_invoice"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description Custom fields displayed on the invoice. */ + /** + * @nullable + * @description Custom fields displayed on the invoice. + */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; - /** @description The ID of the customer who will be billed. */ + /** + * @nullable + * @description The ID of the customer who will be billed. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated. + */ customer_address?: components["schemas"]["address"] | null; - /** @description The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. + */ customer_email?: string | null; - /** @description The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated. + */ customer_name?: string | null; - /** @description The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated. + */ customer_phone?: string | null; - /** @description The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated. + */ customer_shipping?: components["schemas"]["shipping"] | null; /** + * @nullable * @description The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated. * @enum {string|null} */ customer_tax_exempt?: "exempt" | "none" | "reverse" | null; - /** @description The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated. + */ customer_tax_ids?: components["schemas"]["invoices_resource_invoice_tax_id"][] | null; - /** @description ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. */ + /** + * @nullable + * @description ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. + */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. */ + /** + * @nullable + * @description ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. + */ default_source?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]) | null; /** @description The tax rates applied to this invoice, if any. */ default_tax_rates: components["schemas"]["tax_rate"][]; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. + */ description?: string | null; - /** @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ + /** + * @nullable + * @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. + */ discount?: components["schemas"]["discount"] | null; /** @description The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ discounts: (string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"])[]; /** - * Format: unix-time + * @nullable * @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. + * @format unix-time */ due_date?: number | null; /** - * Format: unix-time + * @nullable * @description The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. + * @format unix-time */ effective_at?: number | null; - /** @description Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. */ + /** + * @nullable + * @description Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. + */ ending_balance?: number | null; - /** @description Footer displayed on the invoice. */ + /** + * @nullable + * @description Footer displayed on the invoice. + */ footer?: string | null; - /** @description Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. */ + /** + * @nullable + * @description Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. + */ from_invoice?: components["schemas"]["invoices_resource_from_invoice"] | null; - /** @description The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. */ + /** + * @nullable + * @description The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. + */ hosted_invoice_url?: string | null; /** @description Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details. */ id?: string; - /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ + /** + * @nullable + * @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. + */ invoice_pdf?: string | null; issuer: components["schemas"]["connect_account_reference"]; - /** @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. */ + /** + * @nullable + * @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. + */ last_finalization_error?: components["schemas"]["api_errors"] | null; - /** @description The ID of the most recent non-draft revision of this invoice */ + /** + * @nullable + * @description The ID of the most recent non-draft revision of this invoice + */ latest_revision?: (string | components["schemas"]["invoice"]) | null; /** * InvoiceLinesList @@ -15381,101 +16934,164 @@ export interface components { }; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; /** - * Format: unix-time + * @nullable * @description The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. + * @format unix-time */ next_payment_attempt?: number | null; - /** @description A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. */ + /** + * @nullable + * @description A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. + */ number?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "invoice"; - /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + /** + * @nullable + * @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** @description Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance. */ paid: boolean; /** @description Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. */ paid_out_of_band: boolean; - /** @description The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent. */ + /** + * @nullable + * @description The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; payment_settings: components["schemas"]["invoices_payment_settings"]; /** - * Format: unix-time * @description End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. + * @format unix-time */ period_end: number; /** - * Format: unix-time * @description Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. + * @format unix-time */ period_start: number; /** @description Total amount of all post-payment credit notes issued for this invoice. */ post_payment_credit_notes_amount: number; /** @description Total amount of all pre-payment credit notes issued for this invoice. */ pre_payment_credit_notes_amount: number; - /** @description The quote this invoice was generated from. */ + /** + * @nullable + * @description The quote this invoice was generated from. + */ quote?: (string | components["schemas"]["quote"]) | null; - /** @description This is the transaction number that appears on email receipts sent for this invoice. */ + /** + * @nullable + * @description This is the transaction number that appears on email receipts sent for this invoice. + */ receipt_number?: string | null; - /** @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. */ + /** + * @nullable + * @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. + */ rendering?: components["schemas"]["invoices_resource_invoice_rendering"] | null; - /** @description The details of the cost of shipping, including the ShippingRate applied on the invoice. */ + /** + * @nullable + * @description The details of the cost of shipping, including the ShippingRate applied on the invoice. + */ shipping_cost?: components["schemas"]["invoices_resource_shipping_cost"] | null; - /** @description Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. */ + /** + * @nullable + * @description Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. + */ shipping_details?: components["schemas"]["shipping"] | null; /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice. */ starting_balance: number; - /** @description Extra information about an invoice for the customer's credit card statement. */ + /** + * @nullable + * @description Extra information about an invoice for the customer's credit card statement. + */ statement_descriptor?: string | null; /** + * @nullable * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) * @enum {string|null} */ status?: "draft" | "open" | "paid" | "uncollectible" | "void" | null; status_transitions: components["schemas"]["invoices_resource_status_transitions"]; - /** @description The subscription that this invoice was prepared for, if any. */ + /** + * @nullable + * @description The subscription that this invoice was prepared for, if any. + */ subscription?: (string | components["schemas"]["subscription"]) | null; - /** @description Details about the subscription that created this invoice. */ + /** + * @nullable + * @description Details about the subscription that created this invoice. + */ subscription_details?: components["schemas"]["subscription_details_data"] | null; /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ subscription_proration_date?: number; /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated */ subtotal: number; - /** @description The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated + */ subtotal_excluding_tax?: number | null; - /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ + /** + * @nullable + * @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. + */ tax?: number | null; - /** @description ID of the test clock this invoice belongs to. */ + /** + * @nullable + * @description ID of the test clock this invoice belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; threshold_reason?: components["schemas"]["invoice_threshold_reason"]; /** @description Total after discounts and taxes. */ total: number; - /** @description The aggregate amounts calculated per discount across all line items. */ + /** + * @nullable + * @description The aggregate amounts calculated per discount across all line items. + */ total_discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; - /** @description The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. + */ total_excluding_tax?: number | null; - /** @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. */ + /** + * @nullable + * @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. + */ total_pretax_credit_amounts?: components["schemas"]["invoices_resource_pretax_credit_amount"][] | null; /** @description The aggregate amounts calculated per tax rate for all line items. */ total_tax_amounts: components["schemas"]["invoice_tax_amount"][]; - /** @description The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. */ + /** + * @nullable + * @description The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. + */ transfer_data?: components["schemas"]["invoice_transfer_data"] | null; /** - * Format: unix-time + * @nullable * @description Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. + * @format unix-time */ webhooks_delivered_at?: number | null; }; /** invoice_installments_card */ invoice_installments_card: { - /** @description Whether Installments are enabled for this Invoice. */ + /** + * @nullable + * @description Whether Installments are enabled for this Invoice. + */ enabled?: boolean | null; }; /** InvoiceItemThresholdReason */ @@ -15488,26 +17104,33 @@ export interface components { /** InvoiceLineItemPeriod */ invoice_line_item_period: { /** - * Format: unix-time * @description The end of the period, which must be greater than or equal to the start. This value is inclusive. + * @format unix-time */ end: number; /** - * Format: unix-time * @description The start of the period. This value is inclusive. + * @format unix-time */ start: number; }; /** invoice_mandate_options_card */ invoice_mandate_options_card: { - /** @description Amount to be charged for future payments. */ + /** + * @nullable + * @description Amount to be charged for future payments. + */ amount?: number | null; /** + * @nullable * @description One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. * @enum {string|null} */ amount_type?: "fixed" | "maximum" | null; - /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ + /** + * @nullable + * @description A description of the mandate or subscription that is meant to be displayed to the customer. + */ description?: string | null; }; /** invoice_payment_method_options_acss_debit */ @@ -15522,6 +17145,7 @@ export interface components { /** invoice_payment_method_options_acss_debit_mandate_options */ invoice_payment_method_options_acss_debit_mandate_options: { /** + * @nullable * @description Transaction type of the mandate. * @enum {string|null} */ @@ -15539,6 +17163,7 @@ export interface components { invoice_payment_method_options_card: { installments?: components["schemas"]["invoice_installments_card"]; /** + * @nullable * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ @@ -15548,6 +17173,7 @@ export interface components { invoice_payment_method_options_customer_balance: { bank_transfer?: components["schemas"]["invoice_payment_method_options_customer_balance_bank_transfer"]; /** + * @nullable * @description The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. * @enum {string|null} */ @@ -15556,7 +17182,10 @@ export interface components { /** invoice_payment_method_options_customer_balance_bank_transfer */ invoice_payment_method_options_customer_balance_bank_transfer: { eu_bank_transfer?: components["schemas"]["invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer"]; - /** @description The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. */ + /** + * @nullable + * @description The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. + */ type?: string | null; }; /** invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer */ @@ -15585,7 +17214,10 @@ export interface components { filters?: components["schemas"]["invoice_payment_method_options_us_bank_account_linked_account_options_filters"]; /** @description The list of permissions to request. The `payment_method` permission must be included. */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - /** @description Data features requested to be retrieved upon account creation. */ + /** + * @nullable + * @description Data features requested to be retrieved upon account creation. + */ prefetch?: ("balances" | "ownership" | "transactions")[] | null; }; /** invoice_payment_method_options_us_bank_account_linked_account_options_filters */ @@ -15596,6 +17228,7 @@ export interface components { /** InvoiceRenderingPdf */ invoice_rendering_pdf: { /** + * @nullable * @description Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale. * @enum {string|null} */ @@ -15608,19 +17241,25 @@ export interface components { */ invoice_rendering_template: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description A brief description of the template, hidden from customers */ + /** + * @nullable + * @description A brief description of the template, hidden from customers + */ nickname?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -15644,47 +17283,86 @@ export interface components { }; /** InvoiceSettingCustomerRenderingOptions */ invoice_setting_customer_rendering_options: { - /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + /** + * @nullable + * @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. + */ amount_tax_display?: string | null; - /** @description ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. */ + /** + * @nullable + * @description ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. + */ template?: string | null; }; /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { - /** @description Default custom fields to be displayed on invoices for this customer. */ + /** + * @nullable + * @description Default custom fields to be displayed on invoices for this customer. + */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; - /** @description ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. */ + /** + * @nullable + * @description ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. + */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description Default footer to be displayed on invoices for this customer. */ + /** + * @nullable + * @description Default footer to be displayed on invoices for this customer. + */ footer?: string | null; - /** @description Default options for invoice PDF rendering for this customer. */ + /** + * @nullable + * @description Default options for invoice PDF rendering for this customer. + */ rendering_options?: components["schemas"]["invoice_setting_customer_rendering_options"] | null; }; /** InvoiceSettingQuoteSetting */ invoice_setting_quote_setting: { - /** @description Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. */ + /** + * @nullable + * @description Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. + */ days_until_due?: number | null; issuer: components["schemas"]["connect_account_reference"]; }; /** InvoiceSettingRenderingOptions */ invoice_setting_rendering_options: { - /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + /** + * @nullable + * @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. + */ amount_tax_display?: string | null; }; /** InvoiceSettingSubscriptionSchedulePhaseSetting */ invoice_setting_subscription_schedule_phase_setting: { - /** @description The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. */ + /** + * @nullable + * @description The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; - /** @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. */ + /** + * @nullable + * @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. + */ days_until_due?: number | null; - /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + /** + * @nullable + * @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. + */ issuer?: components["schemas"]["connect_account_reference"] | null; }; /** InvoiceSettingSubscriptionScheduleSetting */ invoice_setting_subscription_schedule_setting: { - /** @description The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. */ + /** + * @nullable + * @description The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; - /** @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. */ + /** + * @nullable + * @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. + */ days_until_due?: number | null; issuer: components["schemas"]["connect_account_reference"]; }; @@ -15697,23 +17375,33 @@ export interface components { /** @description The tax rate that was applied to get this tax amount. */ tax_rate: string | components["schemas"]["tax_rate"]; /** + * @nullable * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. * @enum {string|null} */ taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in cents (or local equivalent). */ + /** + * @nullable + * @description The amount on which tax is calculated, in cents (or local equivalent). + */ taxable_amount?: number | null; }; /** InvoiceThresholdReason */ invoice_threshold_reason: { - /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ + /** + * @nullable + * @description The total invoice amount threshold boundary if it triggered the threshold invoice. + */ amount_gte?: number | null; /** @description Indicates which line items triggered a threshold invoice. */ item_reasons: components["schemas"]["invoice_item_threshold_reason"][]; }; /** InvoiceTransferData */ invoice_transfer_data: { - /** @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ + /** + * @nullable + * @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. + */ amount?: number | null; /** @description The account where funds from the payment will be transferred to upon payment success. */ destination: string | components["schemas"]["account"]; @@ -15736,30 +17424,42 @@ export interface components { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The ID of the customer who will be billed when this invoice item is billed. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ date: number; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description If true, discounts will apply to this invoice item. Always false for prorations. */ discountable: boolean; - /** @description The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ + /** + * @nullable + * @description The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. + */ discounts?: (string | components["schemas"]["discount"])[] | null; /** @description Unique identifier for the object. */ id: string; - /** @description The ID of the invoice this invoice item belongs to. */ + /** + * @nullable + * @description The ID of the invoice this invoice item belongs to. + */ invoice?: (string | components["schemas"]["invoice"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -15769,52 +17469,98 @@ export interface components { */ object: "invoiceitem"; period: components["schemas"]["invoice_line_item_period"]; - /** @description The price of the invoice item. */ + /** + * @nullable + * @description The price of the invoice item. + */ price?: components["schemas"]["price"] | null; /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ proration: boolean; /** @description Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for. */ quantity: number; - /** @description The subscription that this invoice item has been created for, if any. */ + /** + * @nullable + * @description The subscription that this invoice item has been created for, if any. + */ subscription?: (string | components["schemas"]["subscription"]) | null; /** @description The subscription item that this invoice item has been created for, if any. */ subscription_item?: string; - /** @description The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. */ + /** + * @nullable + * @description The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. + */ tax_rates?: components["schemas"]["tax_rate"][] | null; - /** @description ID of the test clock this invoice item belongs to. */ + /** + * @nullable + * @description ID of the test clock this invoice item belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; - /** @description Unit amount (in the `currency` specified) of the invoice item. */ + /** + * @nullable + * @description Unit amount (in the `currency` specified) of the invoice item. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ unit_amount_decimal?: string | null; }; /** InvoicesPaymentMethodOptions */ invoices_payment_method_options: { - /** @description If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent. + */ acss_debit?: components["schemas"]["invoice_payment_method_options_acss_debit"] | null; - /** @description If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. + */ bancontact?: components["schemas"]["invoice_payment_method_options_bancontact"] | null; - /** @description If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. + */ card?: components["schemas"]["invoice_payment_method_options_card"] | null; - /** @description If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent. + */ customer_balance?: components["schemas"]["invoice_payment_method_options_customer_balance"] | null; - /** @description If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent. + */ konbini?: components["schemas"]["invoice_payment_method_options_konbini"] | null; - /** @description If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent. + */ sepa_debit?: components["schemas"]["invoice_payment_method_options_sepa_debit"] | null; - /** @description If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent. + */ us_bank_account?: components["schemas"]["invoice_payment_method_options_us_bank_account"] | null; }; /** InvoicesPaymentSettings */ invoices_payment_settings: { - /** @description ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. */ + /** + * @nullable + * @description ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. + */ default_mandate?: string | null; - /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. + */ payment_method_options?: components["schemas"]["invoices_payment_method_options"] | null; - /** @description The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ + /** + * @nullable + * @description The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). + */ payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; }; /** InvoicesResourceFromInvoice */ @@ -15826,13 +17572,25 @@ export interface components { }; /** InvoicesResourceInvoiceRendering */ invoices_resource_invoice_rendering: { - /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + /** + * @nullable + * @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. + */ amount_tax_display?: string | null; - /** @description Invoice pdf rendering options */ + /** + * @nullable + * @description Invoice pdf rendering options + */ pdf?: components["schemas"]["invoice_rendering_pdf"] | null; - /** @description ID of the rendering template that the invoice is formatted by. */ + /** + * @nullable + * @description ID of the rendering template that the invoice is formatted by. + */ template?: string | null; - /** @description Version of the rendering template that the invoice is using. */ + /** + * @nullable + * @description Version of the rendering template that the invoice is using. + */ template_version?: number | null; }; /** InvoicesResourceInvoiceTaxID */ @@ -15842,7 +17600,10 @@ export interface components { * @enum {string} */ type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; - /** @description The value of the tax ID. */ + /** + * @nullable + * @description The value of the tax ID. + */ value?: string | null; }; /** InvoicesResourceLineItemsCreditedItems */ @@ -15854,14 +17615,20 @@ export interface components { }; /** InvoicesResourceLineItemsProrationDetails */ invoices_resource_line_items_proration_details: { - /** @description For a credit proration `line_item`, the original debit line_items to which the credit proration applies. */ + /** + * @nullable + * @description For a credit proration `line_item`, the original debit line_items to which the credit proration applies. + */ credited_items?: components["schemas"]["invoices_resource_line_items_credited_items"] | null; }; /** InvoicesResourcePretaxCreditAmount */ invoices_resource_pretax_credit_amount: { /** @description The amount, in cents (or local equivalent), of the pretax credit amount. */ amount: number; - /** @description The credit balance transaction that was applied to get this pretax credit amount. */ + /** + * @nullable + * @description The credit balance transaction that was applied to get this pretax credit amount. + */ credit_balance_transaction?: (string | components["schemas"]["billing.credit_balance_transaction"]) | null; /** @description The discount that was applied to get this pretax credit amount. */ discount?: string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"]; @@ -15879,7 +17646,10 @@ export interface components { amount_tax: number; /** @description Total shipping cost after taxes are applied. */ amount_total: number; - /** @description The ID of the ShippingRate for this invoice. */ + /** + * @nullable + * @description The ID of the ShippingRate for this invoice. + */ shipping_rate?: (string | components["schemas"]["shipping_rate"]) | null; /** @description The taxes applied to the shipping rate. */ taxes?: components["schemas"]["line_items_tax_amount"][]; @@ -15887,23 +17657,27 @@ export interface components { /** InvoicesResourceStatusTransitions */ invoices_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description The time that the invoice draft was finalized. + * @format unix-time */ finalized_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the invoice was marked uncollectible. + * @format unix-time */ marked_uncollectible_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the invoice was paid. + * @format unix-time */ paid_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the invoice was voided. + * @format unix-time */ voided_at?: number | null; }; @@ -15918,7 +17692,10 @@ export interface components { "issuing.authorization": { /** @description The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different. */ amount: number; - /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** + * @nullable + * @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; /** @description Whether the authorization has been approved. */ approved: boolean; @@ -15930,23 +17707,35 @@ export interface components { /** @description List of balance transactions associated with this authorization. */ balance_transactions: components["schemas"]["balance_transaction"][]; card: components["schemas"]["issuing.card"]; - /** @description The cardholder to whom this authorization belongs. */ + /** + * @nullable + * @description The cardholder to whom this authorization belongs. + */ cardholder?: (string | components["schemas"]["issuing.cardholder"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description Fleet-specific information for authorizations using Fleet cards. */ + /** + * @nullable + * @description Fleet-specific information for authorizations using Fleet cards. + */ fleet?: components["schemas"]["issuing_authorization_fleet_data"] | null; - /** @description Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. */ + /** + * @nullable + * @description Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. + */ fraud_challenges?: components["schemas"]["issuing_authorization_fraud_challenge"][] | null; - /** @description Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. */ + /** + * @nullable + * @description Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. + */ fuel?: components["schemas"]["issuing_authorization_fuel_data"] | null; /** @description Unique identifier for the object. */ id: string; @@ -15955,8 +17744,8 @@ export interface components { /** @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; /** - * Format: currency * @description The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; @@ -15964,14 +17753,20 @@ export interface components { metadata: { [key: string]: string; }; - /** @description Details about the authorization, such as identifiers, set by the card network. */ + /** + * @nullable + * @description Details about the authorization, such as identifiers, set by the card network. + */ network_data?: components["schemas"]["issuing_authorization_network_data"] | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "issuing.authorization"; - /** @description The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. */ + /** + * @nullable + * @description The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. + */ pending_request?: components["schemas"]["issuing_authorization_pending_request"] | null; /** @description History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. */ request_history: components["schemas"]["issuing_authorization_request"][]; @@ -15980,16 +17775,28 @@ export interface components { * @enum {string} */ status: "closed" | "pending" | "reversed"; - /** @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. */ + /** + * @nullable + * @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. + */ token?: (string | components["schemas"]["issuing.token"]) | null; /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ transactions: components["schemas"]["issuing.transaction"][]; - /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). */ + /** + * @nullable + * @description [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). + */ treasury?: components["schemas"]["issuing_authorization_treasury"] | null; verification_data: components["schemas"]["issuing_authorization_verification_data"]; - /** @description Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. */ + /** + * @nullable + * @description Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. + */ verified_by_fraud_challenge?: boolean | null; - /** @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. */ + /** + * @nullable + * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. + */ wallet?: string | null; }; /** @@ -16000,19 +17807,20 @@ export interface components { /** @description The brand of the card. */ brand: string; /** + * @nullable * @description The reason why the card was canceled. * @enum {string|null} */ cancellation_reason?: "design_rejected" | "lost" | "stolen" | null; cardholder: components["schemas"]["issuing.cardholder"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. + * @format currency */ currency: string; /** @description The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ @@ -16021,7 +17829,10 @@ export interface components { exp_month: number; /** @description The expiration year of the card. */ exp_year: number; - /** @description The financial account this card is attached to. */ + /** + * @nullable + * @description The financial account this card is attached to. + */ financial_account?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -16040,18 +17851,31 @@ export interface components { * @enum {string} */ object: "issuing.card"; - /** @description The personalization design object belonging to this card. */ + /** + * @nullable + * @description The personalization design object belonging to this card. + */ personalization_design?: (string | components["schemas"]["issuing.personalization_design"]) | null; - /** @description The latest card that replaces this card, if any. */ + /** + * @nullable + * @description The latest card that replaces this card, if any. + */ replaced_by?: (string | components["schemas"]["issuing.card"]) | null; - /** @description The card this card replaces, if any. */ + /** + * @nullable + * @description The card this card replaces, if any. + */ replacement_for?: (string | components["schemas"]["issuing.card"]) | null; /** + * @nullable * @description The reason why the previous card needed to be replaced. * @enum {string|null} */ replacement_reason?: "damaged" | "expired" | "lost" | "stolen" | null; - /** @description Where and how the card will be shipped. */ + /** + * @nullable + * @description Where and how the card will be shipped. + */ shipping?: components["schemas"]["issuing_card_shipping"] | null; spending_controls: components["schemas"]["issuing_card_authorization_controls"]; /** @@ -16064,7 +17888,10 @@ export interface components { * @enum {string} */ type: "physical" | "virtual"; - /** @description Information relating to digital wallets (like Apple Pay and Google Pay). */ + /** + * @nullable + * @description Information relating to digital wallets (like Apple Pay and Google Pay). + */ wallets?: components["schemas"]["issuing_card_wallets"] | null; }; /** @@ -16075,18 +17902,27 @@ export interface components { */ "issuing.cardholder": { billing: components["schemas"]["issuing_cardholder_address"]; - /** @description Additional information about a `company` cardholder. */ + /** + * @nullable + * @description Additional information about a `company` cardholder. + */ company?: components["schemas"]["issuing_cardholder_company"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The cardholder's email address. */ + /** + * @nullable + * @description The cardholder's email address. + */ email?: string | null; /** @description Unique identifier for the object. */ id: string; - /** @description Additional information about an `individual` cardholder. */ + /** + * @nullable + * @description Additional information about an `individual` cardholder. + */ individual?: components["schemas"]["issuing_cardholder_individual"] | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -16101,15 +17937,22 @@ export interface components { * @enum {string} */ object: "issuing.cardholder"; - /** @description The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. */ + /** + * @nullable + * @description The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. + */ phone_number?: string | null; /** + * @nullable * @description The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. * This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. */ preferred_locales?: ("de" | "en" | "es" | "fr" | "it")[] | null; requirements: components["schemas"]["issuing_cardholder_requirements"]; - /** @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ + /** + * @nullable + * @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + */ spending_controls?: components["schemas"]["issuing_cardholder_authorization_controls"] | null; /** * @description Specifies whether to permit authorizations on this cardholder's cards. @@ -16131,16 +17974,19 @@ export interface components { "issuing.dispute": { /** @description Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ amount: number; - /** @description List of balance transactions associated with the dispute. */ + /** + * @nullable + * @description List of balance transactions associated with the dispute. + */ balance_transactions?: components["schemas"]["balance_transaction"][] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description The currency the `transaction` was made in. + * @format currency */ currency: string; evidence: components["schemas"]["issuing_dispute_evidence"]; @@ -16169,7 +18015,10 @@ export interface components { status: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; /** @description The transaction being disputed. */ transaction: string | components["schemas"]["issuing.transaction"]; - /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ + /** + * @nullable + * @description [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts + */ treasury?: components["schemas"]["issuing_dispute_treasury"] | null; }; /** @@ -16177,26 +18026,38 @@ export interface components { * @description A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line. */ "issuing.personalization_design": { - /** @description The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. */ + /** + * @nullable + * @description The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. + */ card_logo?: (string | components["schemas"]["file"]) | null; - /** @description Hash containing carrier text, for use with physical bundles that support carrier text. */ + /** + * @nullable + * @description Hash containing carrier text, for use with physical bundles that support carrier text. + */ carrier_text?: components["schemas"]["issuing_personalization_design_carrier_text"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. */ + /** + * @nullable + * @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. + */ lookup_key?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { [key: string]: string; }; - /** @description Friendly display name. */ + /** + * @nullable + * @description Friendly display name. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -16249,18 +18110,18 @@ export interface components { /** @description The Bank Identification Number reflecting this settlement record. */ bin: string; /** - * Format: unix-time * @description The date that the transactions are cleared and posted to user's accounts. + * @format unix-time */ clearing_date: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Unique identifier for the object. */ @@ -16309,11 +18170,14 @@ export interface components { /** @description Card associated with this token. */ card: string | components["schemas"]["issuing.card"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The hashed ID derived from the device ID from the card network associated with the token. */ + /** + * @nullable + * @description The hashed ID derived from the device ID from the card network associated with the token. + */ device_fingerprint?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -16328,8 +18192,8 @@ export interface components { network: "mastercard" | "visa"; network_data?: components["schemas"]["issuing_network_token_network_data"]; /** - * Format: unix-time * @description Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch. + * @format unix-time */ network_updated_at: number; /** @@ -16359,27 +18223,42 @@ export interface components { "issuing.transaction": { /** @description The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ 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). */ + /** + * @nullable + * @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_transaction_amount_details"] | null; - /** @description The `Authorization` object that led to this transaction. */ + /** + * @nullable + * @description The `Authorization` object that led to this transaction. + */ authorization?: (string | components["schemas"]["issuing.authorization"]) | null; - /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ + /** + * @nullable + * @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** @description The card used to make this transaction. */ card: string | components["schemas"]["issuing.card"]; - /** @description The cardholder to whom this transaction belongs. */ + /** + * @nullable + * @description The cardholder to whom this transaction belongs. + */ cardholder?: (string | components["schemas"]["issuing.cardholder"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description If you've disputed the transaction, the ID of the dispute. */ + /** + * @nullable + * @description If you've disputed the transaction, the ID of the dispute. + */ dispute?: (string | components["schemas"]["issuing.dispute"]) | null; /** @description Unique identifier for the object. */ id: string; @@ -16388,8 +18267,8 @@ export interface components { /** @description The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. */ merchant_amount: number; /** - * Format: currency * @description The currency with which the merchant is taking payment. + * @format currency */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; @@ -16397,18 +18276,30 @@ export interface components { metadata: { [key: string]: string; }; - /** @description Details about the transaction, such as processing dates, set by the card network. */ + /** + * @nullable + * @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} */ object: "issuing.transaction"; - /** @description Additional purchase information that is optionally provided by the merchant. */ + /** + * @nullable + * @description Additional purchase information that is optionally provided by the merchant. + */ purchase_details?: components["schemas"]["issuing_transaction_purchase_details"] | null; - /** @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. */ + /** + * @nullable + * @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. + */ token?: (string | components["schemas"]["issuing.token"]) | null; - /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ + /** + * @nullable + * @description [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts + */ treasury?: components["schemas"]["issuing_transaction_treasury"] | null; /** * @description The nature of the transaction. @@ -16416,6 +18307,7 @@ export interface components { */ type: "capture" | "refund"; /** + * @nullable * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. * @enum {string|null} */ @@ -16423,9 +18315,15 @@ export interface components { }; /** IssuingAuthorizationAmountDetails */ issuing_authorization_amount_details: { - /** @description The fee charged by the ATM for the cash withdrawal. */ + /** + * @nullable + * @description The fee charged by the ATM for the cash withdrawal. + */ atm_fee?: number | null; - /** @description The amount of cash requested by the cardholder. */ + /** + * @nullable + * @description The amount of cash requested by the cardholder. + */ cashback_amount?: number | null; }; /** IssuingAuthorizationAuthenticationExemption */ @@ -16443,31 +18341,57 @@ export interface components { }; /** IssuingAuthorizationFleetCardholderPromptData */ issuing_authorization_fleet_cardholder_prompt_data: { - /** @description [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID. */ + /** + * @nullable + * @description [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID. + */ alphanumeric_id?: string | null; - /** @description Driver ID. */ + /** + * @nullable + * @description Driver ID. + */ driver_id?: string | null; - /** @description Odometer reading. */ + /** + * @nullable + * @description Odometer reading. + */ odometer?: number | null; - /** @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. */ + /** + * @nullable + * @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. + */ unspecified_id?: string | null; - /** @description User ID. */ + /** + * @nullable + * @description User ID. + */ user_id?: string | null; - /** @description Vehicle number. */ + /** + * @nullable + * @description Vehicle number. + */ vehicle_number?: string | null; }; /** IssuingAuthorizationFleetData */ issuing_authorization_fleet_data: { - /** @description Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry. */ + /** + * @nullable + * @description Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry. + */ cardholder_prompt_data?: components["schemas"]["issuing_authorization_fleet_cardholder_prompt_data"] | null; /** + * @nullable * @description The type of purchase. * @enum {string|null} */ purchase_type?: "fuel_and_non_fuel_purchase" | "fuel_purchase" | "non_fuel_purchase" | null; - /** @description More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data. */ + /** + * @nullable + * @description More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data. + */ reported_breakdown?: components["schemas"]["issuing_authorization_fleet_reported_breakdown"] | null; /** + * @nullable * @description The type of fuel service. * @enum {string|null} */ @@ -16476,38 +18400,51 @@ export interface components { /** IssuingAuthorizationFleetFuelPriceData */ issuing_authorization_fleet_fuel_price_data: { /** - * Format: decimal + * @nullable * @description Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes. + * @format decimal */ gross_amount_decimal?: string | null; }; /** IssuingAuthorizationFleetNonFuelPriceData */ issuing_authorization_fleet_non_fuel_price_data: { /** - * Format: decimal + * @nullable * @description Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. + * @format decimal */ gross_amount_decimal?: string | null; }; /** IssuingAuthorizationFleetReportedBreakdown */ issuing_authorization_fleet_reported_breakdown: { - /** @description Breakdown of fuel portion of the purchase. */ + /** + * @nullable + * @description Breakdown of fuel portion of the purchase. + */ fuel?: components["schemas"]["issuing_authorization_fleet_fuel_price_data"] | null; - /** @description Breakdown of non-fuel portion of the purchase. */ + /** + * @nullable + * @description Breakdown of non-fuel portion of the purchase. + */ non_fuel?: components["schemas"]["issuing_authorization_fleet_non_fuel_price_data"] | null; - /** @description Information about tax included in this transaction. */ + /** + * @nullable + * @description Information about tax included in this transaction. + */ tax?: components["schemas"]["issuing_authorization_fleet_tax_data"] | null; }; /** IssuingAuthorizationFleetTaxData */ issuing_authorization_fleet_tax_data: { /** - * Format: decimal + * @nullable * @description Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax. + * @format decimal */ local_amount_decimal?: string | null; /** - * Format: decimal + * @nullable * @description Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax. + * @format decimal */ national_amount_decimal?: string | null; }; @@ -16524,6 +18461,7 @@ export interface components { */ status: "expired" | "pending" | "rejected" | "undeliverable" | "verified"; /** + * @nullable * @description If the challenge is not deliverable, the reason why. * @enum {string|null} */ @@ -16531,26 +18469,33 @@ export interface components { }; /** IssuingAuthorizationFuelData */ issuing_authorization_fuel_data: { - /** @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. */ + /** + * @nullable + * @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. + */ industry_product_code?: string | null; /** - * Format: decimal + * @nullable * @description The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. + * @format decimal */ quantity_decimal?: string | null; /** + * @nullable * @description The type of fuel that was purchased. * @enum {string|null} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super" | null; /** + * @nullable * @description The units for `quantity_decimal`. * @enum {string|null} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon" | null; /** - * Format: decimal + * @nullable * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. + * @format decimal */ unit_cost_decimal?: string | null; }; @@ -16560,43 +18505,79 @@ export interface components { category: string; /** @description The merchant category code for the seller’s business */ category_code: string; - /** @description City where the seller is located */ + /** + * @nullable + * @description City where the seller is located + */ city?: string | null; - /** @description Country where the seller is located */ + /** + * @nullable + * @description Country where the seller is located + */ country?: string | null; - /** @description Name of the seller */ + /** + * @nullable + * @description Name of the seller + */ name?: string | null; /** @description Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. */ network_id: string; - /** @description Postal code where the seller is located */ + /** + * @nullable + * @description Postal code where the seller is located + */ postal_code?: string | null; - /** @description State where the seller is located */ + /** + * @nullable + * @description State where the seller is located + */ state?: string | null; - /** @description The seller's tax identification number. Currently populated for French merchants only. */ + /** + * @nullable + * @description The seller's tax identification number. Currently populated for French merchants only. + */ tax_id?: string | null; - /** @description An ID assigned by the seller to the location of the sale. */ + /** + * @nullable + * @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 */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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: { /** @description The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ 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). */ + /** + * @nullable + * @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; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ @@ -16604,26 +18585,35 @@ export interface components { /** @description The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ merchant_amount: number; /** - * Format: currency * @description The local currency the merchant is requesting to authorize. + * @format currency */ merchant_currency: string; - /** @description The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. */ + /** + * @nullable + * @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: { /** @description The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. */ 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). */ + /** + * @nullable + * @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; /** @description Whether this request was approved. */ approved: boolean; - /** @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. */ + /** + * @nullable + * @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; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ 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). */ @@ -16632,18 +18622,25 @@ 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. */ + /** + * @nullable + * @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_canceled" | "card_expired" | "card_inactive" | "cardholder_blocked" | "cardholder_inactive" | "cardholder_verification_required" | "insecure_authorization_method" | "insufficient_funds" | "not_allowed" | "pin_blocked" | "spending_controls" | "suspected_fraud" | "verification_failed" | "webhook_approved" | "webhook_declined" | "webhook_error" | "webhook_timeout"; - /** @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. */ + /** + * @nullable + * @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 + * @nullable * @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 */ requested_at?: number | null; }; @@ -16661,7 +18658,10 @@ export interface components { received_credits: string[]; /** @description The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization */ received_debits: string[]; - /** @description The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization */ + /** + * @nullable + * @description The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization + */ transaction?: string | null; }; /** IssuingAuthorizationVerificationData */ @@ -16676,7 +18676,10 @@ export interface components { * @enum {string} */ address_postal_code_check: "match" | "mismatch" | "not_provided"; - /** @description The exemption applied to this authorization. */ + /** + * @nullable + * @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. @@ -16688,9 +18691,15 @@ export interface components { * @enum {string} */ expiry_check: "match" | "mismatch" | "not_provided"; - /** @description The postal code submitted as part of the authorization used for postal code verification. */ + /** + * @nullable + * @description The postal code submitted as part of the authorization used for postal code verification. + */ postal_code?: string | null; - /** @description 3D Secure details. */ + /** + * @nullable + * @description 3D Secure details. + */ three_d_secure?: components["schemas"]["issuing_authorization_three_d_secure"] | null; }; /** IssuingCardApplePay */ @@ -16698,6 +18707,7 @@ export interface components { /** @description Apple Pay Eligibility */ eligible: boolean; /** + * @nullable * @description Reason the card is ineligible for Apple Pay * @enum {string|null} */ @@ -16705,19 +18715,35 @@ export interface components { }; /** IssuingCardAuthorizationControls */ issuing_card_authorization_controls: { - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. + */ allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; - /** @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ + /** + * @nullable + * @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ allowed_merchant_countries?: string[] | null; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. + */ blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; - /** @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ + /** + * @nullable + * @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ blocked_merchant_countries?: string[] | null; - /** @description Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). */ + /** + * @nullable + * @description Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). + */ spending_limits?: components["schemas"]["issuing_card_spending_limit"][] | null; /** - * Format: currency + * @nullable * @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. + * @format currency */ spending_limits_currency?: string | null; }; @@ -16726,6 +18752,7 @@ export interface components { /** @description Google Pay Eligibility */ eligible: boolean; /** + * @nullable * @description Reason the card is ineligible for Google Pay * @enum {string|null} */ @@ -16734,25 +18761,39 @@ export interface components { /** IssuingCardShipping */ issuing_card_shipping: { address: components["schemas"]["address"]; - /** @description Address validation details for the shipment. */ + /** + * @nullable + * @description Address validation details for the shipment. + */ address_validation?: components["schemas"]["issuing_card_shipping_address_validation"] | null; /** + * @nullable * @description The delivery company that shipped a card. * @enum {string|null} */ carrier?: "dhl" | "fedex" | "royal_mail" | "usps" | null; - /** @description Additional information that may be required for clearing customs. */ + /** + * @nullable + * @description Additional information that may be required for clearing customs. + */ customs?: components["schemas"]["issuing_card_shipping_customs"] | null; /** - * Format: unix-time + * @nullable * @description A unix timestamp representing a best estimate of when the card will be delivered. + * @format unix-time */ eta?: number | null; /** @description Recipient name. */ name: string; - /** @description The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created. */ + /** + * @nullable + * @description The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created. + */ phone_number?: string | null; - /** @description Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true. */ + /** + * @nullable + * @description Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true. + */ require_signature?: boolean | null; /** * @description Shipment service, such as `standard` or `express`. @@ -16760,13 +18801,20 @@ export interface components { */ service: "express" | "priority" | "standard"; /** + * @nullable * @description The delivery status of the card. * @enum {string|null} */ status?: "canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped" | "submitted" | null; - /** @description A tracking number for a card shipment. */ + /** + * @nullable + * @description A tracking number for a card shipment. + */ tracking_number?: string | null; - /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ + /** + * @nullable + * @description A link to the shipping carrier's site where you can view detailed information about a card shipment. + */ tracking_url?: string | null; /** * @description Packaging options. @@ -16781,9 +18829,13 @@ export interface components { * @enum {string} */ mode: "disabled" | "normalization_only" | "validation_and_normalization"; - /** @description The normalized shipping address. */ + /** + * @nullable + * @description The normalized shipping address. + */ normalized_address?: components["schemas"]["address"] | null; /** + * @nullable * @description The validation result for the shipping address. * @enum {string|null} */ @@ -16791,14 +18843,20 @@ export interface components { }; /** IssuingCardShippingCustoms */ issuing_card_shipping_customs: { - /** @description A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU. */ + /** + * @nullable + * @description A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU. + */ eori_number?: string | null; }; /** IssuingCardSpendingLimit */ issuing_card_spending_limit: { /** @description Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount: number; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. + */ categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** * @description Interval (or event) to which the amount applies. @@ -16810,7 +18868,10 @@ export interface components { issuing_card_wallets: { apple_pay: components["schemas"]["issuing_card_apple_pay"]; google_pay: components["schemas"]["issuing_card_google_pay"]; - /** @description Unique identifier for a card used with digital wallets */ + /** + * @nullable + * @description Unique identifier for a card used with digital wallets + */ primary_account_identifier?: string | null; }; /** IssuingCardholderAddress */ @@ -16819,25 +18880,44 @@ export interface components { }; /** IssuingCardholderAuthorizationControls */ issuing_cardholder_authorization_controls: { - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. + */ allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; - /** @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ + /** + * @nullable + * @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ allowed_merchant_countries?: string[] | null; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. + */ blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; - /** @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ + /** + * @nullable + * @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ blocked_merchant_countries?: string[] | null; - /** @description Limit spending with amount-based rules that apply across this cardholder's cards. */ + /** + * @nullable + * @description Limit spending with amount-based rules that apply across this cardholder's cards. + */ spending_limits?: components["schemas"]["issuing_cardholder_spending_limit"][] | null; /** - * Format: currency + * @nullable * @description Currency of the amounts within `spending_limits`. + * @format currency */ spending_limits_currency?: string | null; }; /** IssuingCardholderCardIssuing */ issuing_cardholder_card_issuing: { - /** @description Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program. */ + /** + * @nullable + * @description Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program. + */ user_terms_acceptance?: components["schemas"]["issuing_cardholder_user_terms_acceptance"] | null; }; /** IssuingCardholderCompany */ @@ -16847,48 +18927,85 @@ export interface components { }; /** IssuingCardholderIdDocument */ issuing_cardholder_id_document: { - /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** + * @nullable + * @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + */ back?: (string | components["schemas"]["file"]) | null; - /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** + * @nullable + * @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + */ front?: (string | components["schemas"]["file"]) | null; }; /** IssuingCardholderIndividual */ issuing_cardholder_individual: { - /** @description Information related to the card_issuing program for this cardholder. */ + /** + * @nullable + * @description Information related to the card_issuing program for this cardholder. + */ card_issuing?: components["schemas"]["issuing_cardholder_card_issuing"] | null; - /** @description The date of birth of this cardholder. */ + /** + * @nullable + * @description The date of birth of this cardholder. + */ dob?: components["schemas"]["issuing_cardholder_individual_dob"] | null; - /** @description The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. */ + /** + * @nullable + * @description The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. + */ first_name?: string | null; - /** @description The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. */ + /** + * @nullable + * @description The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. + */ last_name?: string | null; - /** @description Government-issued ID document for this cardholder. */ + /** + * @nullable + * @description Government-issued ID document for this cardholder. + */ verification?: components["schemas"]["issuing_cardholder_verification"] | null; }; /** IssuingCardholderIndividualDOB */ issuing_cardholder_individual_dob: { - /** @description The day of birth, between 1 and 31. */ + /** + * @nullable + * @description The day of birth, between 1 and 31. + */ day?: number | null; - /** @description The month of birth, between 1 and 12. */ + /** + * @nullable + * @description The month of birth, between 1 and 12. + */ month?: number | null; - /** @description The four-digit year of birth. */ + /** + * @nullable + * @description The four-digit year of birth. + */ year?: number | null; }; /** IssuingCardholderRequirements */ issuing_cardholder_requirements: { /** + * @nullable * @description If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. * @enum {string|null} */ disabled_reason?: "listed" | "rejected.listed" | "requirements.past_due" | "under_review" | null; - /** @description Array of fields that need to be collected in order to verify and re-enable the cardholder. */ + /** + * @nullable + * @description Array of fields that need to be collected in order to verify and re-enable the cardholder. + */ past_due?: ("company.tax_id" | "individual.card_issuing.user_terms_acceptance.date" | "individual.card_issuing.user_terms_acceptance.ip" | "individual.dob.day" | "individual.dob.month" | "individual.dob.year" | "individual.first_name" | "individual.last_name" | "individual.verification.document")[] | null; }; /** IssuingCardholderSpendingLimit */ issuing_cardholder_spending_limit: { /** @description Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount: number; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. + */ categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** * @description Interval (or event) to which the amount applies. @@ -16899,71 +19016,119 @@ export interface components { /** IssuingCardholderUserTermsAcceptance */ issuing_cardholder_user_terms_acceptance: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the cardholder accepted the Authorized User Terms. + * @format unix-time */ date?: number | null; - /** @description The IP address from which the cardholder accepted the Authorized User Terms. */ + /** + * @nullable + * @description The IP address from which the cardholder accepted the Authorized User Terms. + */ ip?: string | null; - /** @description The user agent of the browser from which the cardholder accepted the Authorized User Terms. */ + /** + * @nullable + * @description The user agent of the browser from which the cardholder accepted the Authorized User Terms. + */ user_agent?: string | null; }; /** IssuingCardholderVerification */ issuing_cardholder_verification: { - /** @description An identifying document, either a passport or local ID card. */ + /** + * @nullable + * @description An identifying document, either a passport or local ID card. + */ document?: components["schemas"]["issuing_cardholder_id_document"] | null; }; /** IssuingDisputeCanceledEvidence */ issuing_dispute_canceled_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; /** - * Format: unix-time + * @nullable * @description Date when order was canceled. + * @format unix-time */ canceled_at?: number | null; - /** @description Whether the cardholder was provided with a cancellation policy. */ + /** + * @nullable + * @description Whether the cardholder was provided with a cancellation policy. + */ cancellation_policy_provided?: boolean | null; - /** @description Reason for canceling the order. */ + /** + * @nullable + * @description Reason for canceling the order. + */ cancellation_reason?: string | null; /** - * Format: unix-time + * @nullable * @description Date when the cardholder expected to receive the product. + * @format unix-time */ expected_at?: number | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; - /** @description Description of the merchandise or service that was purchased. */ + /** + * @nullable + * @description Description of the merchandise or service that was purchased. + */ product_description?: string | null; /** + * @nullable * @description Whether the product was a merchandise or service. * @enum {string|null} */ product_type?: "merchandise" | "service" | null; /** + * @nullable * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ return_status?: "merchant_rejected" | "successful" | null; /** - * Format: unix-time + * @nullable * @description Date when the product was returned or attempted to be returned. + * @format unix-time */ returned_at?: number | null; }; /** IssuingDisputeDuplicateEvidence */ issuing_dispute_duplicate_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for. + */ card_statement?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash. + */ cash_receipt?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product. + */ check_image?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; - /** @description Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. */ + /** + * @nullable + * @description Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. + */ original_transaction?: string | null; }; /** IssuingDisputeEvidence */ @@ -16984,56 +19149,91 @@ export interface components { }; /** IssuingDisputeFraudulentEvidence */ issuing_dispute_fraudulent_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; }; /** IssuingDisputeMerchandiseNotAsDescribedEvidence */ issuing_dispute_merchandise_not_as_described_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; /** - * Format: unix-time + * @nullable * @description Date when the product was received. + * @format unix-time */ received_at?: number | null; - /** @description Description of the cardholder's attempt to return the product. */ + /** + * @nullable + * @description Description of the cardholder's attempt to return the product. + */ return_description?: string | null; /** + * @nullable * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ return_status?: "merchant_rejected" | "successful" | null; /** - * Format: unix-time + * @nullable * @description Date when the product was returned or attempted to be returned. + * @format unix-time */ returned_at?: number | null; }; /** IssuingDisputeNoValidAuthorizationEvidence */ issuing_dispute_no_valid_authorization_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; }; /** IssuingDisputeNotReceivedEvidence */ issuing_dispute_not_received_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; /** - * Format: unix-time + * @nullable * @description Date when the cardholder expected to receive the product. + * @format unix-time */ expected_at?: number | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; - /** @description Description of the merchandise or service that was purchased. */ + /** + * @nullable + * @description Description of the merchandise or service that was purchased. + */ product_description?: string | null; /** + * @nullable * @description Whether the product was a merchandise or service. * @enum {string|null} */ @@ -17041,13 +19241,23 @@ export interface components { }; /** IssuingDisputeOtherEvidence */ issuing_dispute_other_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; - /** @description Description of the merchandise or service that was purchased. */ + /** + * @nullable + * @description Description of the merchandise or service that was purchased. + */ product_description?: string | null; /** + * @nullable * @description Whether the product was a merchandise or service. * @enum {string|null} */ @@ -17055,26 +19265,40 @@ export interface components { }; /** IssuingDisputeServiceNotAsDescribedEvidence */ issuing_dispute_service_not_as_described_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; /** - * Format: unix-time + * @nullable * @description Date when order was canceled. + * @format unix-time */ canceled_at?: number | null; - /** @description Reason for canceling the order. */ + /** + * @nullable + * @description Reason for canceling the order. + */ cancellation_reason?: string | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; /** - * Format: unix-time + * @nullable * @description Date when the product was received. + * @format unix-time */ received_at?: number | null; }; /** IssuingDisputeTreasury */ issuing_dispute_treasury: { - /** @description The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute */ + /** + * @nullable + * @description The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute + */ debit_reversal?: string | null; /** @description The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed. */ received_debit: string; @@ -17168,27 +19392,48 @@ export interface components { }; /** IssuingPersonalizationDesignCarrierText */ issuing_personalization_design_carrier_text: { - /** @description The footer body text of the carrier letter. */ + /** + * @nullable + * @description The footer body text of the carrier letter. + */ footer_body?: string | null; - /** @description The footer title text of the carrier letter. */ + /** + * @nullable + * @description The footer title text of the carrier letter. + */ footer_title?: string | null; - /** @description The header body text of the carrier letter. */ + /** + * @nullable + * @description The header body text of the carrier letter. + */ header_body?: string | null; - /** @description The header title text of the carrier letter. */ + /** + * @nullable + * @description The header title text of the carrier letter. + */ header_title?: string | null; }; /** IssuingPersonalizationDesignPreferences */ issuing_personalization_design_preferences: { /** @description Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design. */ is_default: boolean; - /** @description Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist. */ + /** + * @nullable + * @description Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist. + */ is_platform_default?: boolean | null; }; /** IssuingPersonalizationDesignRejectionReasons */ issuing_personalization_design_rejection_reasons: { - /** @description The reason(s) the card logo was rejected. */ + /** + * @nullable + * @description The reason(s) the card logo was rejected. + */ card_logo?: ("geographic_location" | "inappropriate" | "network_name" | "non_binary_image" | "non_fiat_currency" | "other" | "other_entity" | "promotional_material")[] | null; - /** @description The reason(s) the carrier text was rejected. */ + /** + * @nullable + * @description The reason(s) the carrier text was rejected. + */ carrier_text?: ("geographic_location" | "inappropriate" | "network_name" | "non_fiat_currency" | "other" | "other_entity" | "promotional_material")[] | null; }; /** IssuingPhysicalBundleFeatures */ @@ -17211,108 +19456,191 @@ export interface components { }; /** IssuingTransactionAmountDetails */ issuing_transaction_amount_details: { - /** @description The fee charged by the ATM for the cash withdrawal. */ + /** + * @nullable + * @description The fee charged by the ATM for the cash withdrawal. + */ atm_fee?: number | null; - /** @description The amount of cash requested by the cardholder. */ + /** + * @nullable + * @description The amount of cash requested by the cardholder. + */ cashback_amount?: number | null; }; /** IssuingTransactionFleetCardholderPromptData */ issuing_transaction_fleet_cardholder_prompt_data: { - /** @description Driver ID. */ + /** + * @nullable + * @description Driver ID. + */ driver_id?: string | null; - /** @description Odometer reading. */ + /** + * @nullable + * @description Odometer reading. + */ odometer?: number | null; - /** @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. */ + /** + * @nullable + * @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. + */ unspecified_id?: string | null; - /** @description User ID. */ + /** + * @nullable + * @description User ID. + */ user_id?: string | null; - /** @description Vehicle number. */ + /** + * @nullable + * @description Vehicle number. + */ vehicle_number?: string | null; }; /** IssuingTransactionFleetData */ issuing_transaction_fleet_data: { - /** @description Answers to prompts presented to cardholder at point of sale. */ + /** + * @nullable + * @description Answers to prompts presented to cardholder at point of sale. + */ cardholder_prompt_data?: components["schemas"]["issuing_transaction_fleet_cardholder_prompt_data"] | null; - /** @description The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. */ + /** + * @nullable + * @description The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. + */ purchase_type?: string | null; - /** @description More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data. */ + /** + * @nullable + * @description More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data. + */ reported_breakdown?: components["schemas"]["issuing_transaction_fleet_reported_breakdown"] | null; - /** @description The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`. */ + /** + * @nullable + * @description The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`. + */ service_type?: string | null; }; /** IssuingTransactionFleetFuelPriceData */ issuing_transaction_fleet_fuel_price_data: { /** - * Format: decimal + * @nullable * @description Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes. + * @format decimal */ gross_amount_decimal?: string | null; }; /** IssuingTransactionFleetNonFuelPriceData */ issuing_transaction_fleet_non_fuel_price_data: { /** - * Format: decimal + * @nullable * @description Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. + * @format decimal */ gross_amount_decimal?: string | null; }; /** IssuingTransactionFleetReportedBreakdown */ issuing_transaction_fleet_reported_breakdown: { - /** @description Breakdown of fuel portion of the purchase. */ + /** + * @nullable + * @description Breakdown of fuel portion of the purchase. + */ fuel?: components["schemas"]["issuing_transaction_fleet_fuel_price_data"] | null; - /** @description Breakdown of non-fuel portion of the purchase. */ + /** + * @nullable + * @description Breakdown of non-fuel portion of the purchase. + */ non_fuel?: components["schemas"]["issuing_transaction_fleet_non_fuel_price_data"] | null; - /** @description Information about tax included in this transaction. */ + /** + * @nullable + * @description Information about tax included in this transaction. + */ tax?: components["schemas"]["issuing_transaction_fleet_tax_data"] | null; }; /** IssuingTransactionFleetTaxData */ issuing_transaction_fleet_tax_data: { /** - * Format: decimal + * @nullable * @description Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax. + * @format decimal */ local_amount_decimal?: string | null; /** - * Format: decimal + * @nullable * @description Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax. + * @format decimal */ national_amount_decimal?: string | null; }; /** IssuingTransactionFlightData */ issuing_transaction_flight_data: { - /** @description The time that the flight departed. */ + /** + * @nullable + * @description The time that the flight departed. + */ departure_at?: number | null; - /** @description The name of the passenger. */ + /** + * @nullable + * @description The name of the passenger. + */ passenger_name?: string | null; - /** @description Whether the ticket is refundable. */ + /** + * @nullable + * @description Whether the ticket is refundable. + */ refundable?: boolean | null; - /** @description The legs of the trip. */ + /** + * @nullable + * @description The legs of the trip. + */ segments?: components["schemas"]["issuing_transaction_flight_data_leg"][] | null; - /** @description The travel agency that issued the ticket. */ + /** + * @nullable + * @description The travel agency that issued the ticket. + */ travel_agency?: string | null; }; /** IssuingTransactionFlightDataLeg */ issuing_transaction_flight_data_leg: { - /** @description The three-letter IATA airport code of the flight's destination. */ + /** + * @nullable + * @description The three-letter IATA airport code of the flight's destination. + */ arrival_airport_code?: string | null; - /** @description The airline carrier code. */ + /** + * @nullable + * @description The airline carrier code. + */ carrier?: string | null; - /** @description The three-letter IATA airport code that the flight departed from. */ + /** + * @nullable + * @description The three-letter IATA airport code that the flight departed from. + */ departure_airport_code?: string | null; - /** @description The flight number. */ + /** + * @nullable + * @description The flight number. + */ flight_number?: string | null; - /** @description The flight's service class. */ + /** + * @nullable + * @description The flight's service class. + */ service_class?: string | null; - /** @description Whether a stopover is allowed on this flight. */ + /** + * @nullable + * @description Whether a stopover is allowed on this flight. + */ stopover_allowed?: boolean | null; }; /** IssuingTransactionFuelData */ issuing_transaction_fuel_data: { - /** @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. */ + /** + * @nullable + * @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. + */ industry_product_code?: string | null; /** - * Format: decimal + * @nullable * @description The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. + * @format decimal */ quantity_decimal?: string | null; /** @description The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. */ @@ -17320,58 +19648,109 @@ export interface components { /** @description The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`. */ unit: string; /** - * Format: decimal * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. + * @format decimal */ unit_cost_decimal: string; }; /** IssuingTransactionLodgingData */ issuing_transaction_lodging_data: { - /** @description The time of checking into the lodging. */ + /** + * @nullable + * @description The time of checking into the lodging. + */ check_in_at?: number | null; - /** @description The number of nights stayed at the lodging. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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 Fleet-specific information for transactions using Fleet cards. */ + /** + * @nullable + * @description Fleet-specific information for transactions using Fleet cards. + */ fleet?: components["schemas"]["issuing_transaction_fleet_data"] | null; - /** @description Information about the flight that was purchased with this transaction. */ + /** + * @nullable + * @description Information about the flight that was purchased with this transaction. + */ flight?: components["schemas"]["issuing_transaction_flight_data"] | null; - /** @description Information about fuel that was purchased with this transaction. */ + /** + * @nullable + * @description Information about fuel that was purchased with this transaction. + */ fuel?: components["schemas"]["issuing_transaction_fuel_data"] | null; - /** @description Information about lodging that was purchased with this transaction. */ + /** + * @nullable + * @description Information about lodging that was purchased with this transaction. + */ lodging?: components["schemas"]["issuing_transaction_lodging_data"] | null; - /** @description The line items in the purchase. */ + /** + * @nullable + * @description The line items in the purchase. + */ receipt?: components["schemas"]["issuing_transaction_receipt_data"][] | null; - /** @description A merchant-specific order number. */ + /** + * @nullable + * @description A merchant-specific order number. + */ reference?: string | null; }; /** IssuingTransactionReceiptData */ issuing_transaction_receipt_data: { - /** @description The description of the item. The maximum length of this field is 26 characters. */ + /** + * @nullable + * @description The description of the item. The maximum length of this field is 26 characters. + */ description?: string | null; - /** @description The quantity of the item. */ + /** + * @nullable + * @description The quantity of the item. + */ quantity?: number | null; - /** @description The total for this line item in cents. */ + /** + * @nullable + * @description The total for this line item in cents. + */ total?: number | null; - /** @description The unit cost of the item in cents. */ + /** + * @nullable + * @description The unit cost of the item in cents. + */ unit_cost?: number | null; }; /** IssuingTransactionTreasury */ issuing_transaction_treasury: { - /** @description The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund */ + /** + * @nullable + * @description The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund + */ received_credit?: string | null; - /** @description The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture */ + /** + * @nullable + * @description The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture + */ received_debit?: string | null; }; /** @@ -17388,11 +19767,14 @@ export interface components { /** @description Total after discounts and taxes. */ amount_total: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. + */ description?: string | null; /** @description The discounts applied to the line item. */ discounts?: components["schemas"]["line_items_discount_amount"][]; @@ -17403,33 +19785,54 @@ export interface components { * @enum {string} */ object: "item"; - /** @description The price used to generate the line item. */ + /** + * @nullable + * @description The price used to generate the line item. + */ price?: components["schemas"]["price"] | null; - /** @description The quantity of products being purchased. */ + /** + * @nullable + * @description The quantity of products being purchased. + */ quantity?: number | null; /** @description The taxes applied to the line item. */ taxes?: components["schemas"]["line_items_tax_amount"][]; }; /** klarna_address */ klarna_address: { - /** @description The payer address country */ + /** + * @nullable + * @description The payer address country + */ country?: string | null; }; /** klarna_payer_details */ klarna_payer_details: { - /** @description The payer's address */ + /** + * @nullable + * @description The payer's address + */ address?: components["schemas"]["klarna_address"] | null; }; /** LegalEntityCompany */ legal_entity_company: { address?: components["schemas"]["address"]; - /** @description The Kana variation of the company's primary address (Japan only). */ + /** + * @nullable + * @description The Kana variation of the company's primary address (Japan only). + */ address_kana?: components["schemas"]["legal_entity_japan_address"] | null; - /** @description The Kanji variation of the company's primary address (Japan only). */ + /** + * @nullable + * @description The Kanji variation of the company's primary address (Japan only). + */ address_kanji?: components["schemas"]["legal_entity_japan_address"] | null; /** @description Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). */ directors_provided?: boolean; - /** @description This hash is used to attest that the director information provided to Stripe is both current and correct. */ + /** + * @nullable + * @description This hash is used to attest that the director information provided to Stripe is both current and correct. + */ directorship_declaration?: components["schemas"]["legal_entity_directorship_declaration"] | null; /** @description Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. */ executives_provided?: boolean; @@ -17437,19 +19840,34 @@ export interface components { export_license_id?: string; /** @description The purpose code to use for export transactions (India only). */ export_purpose_code?: string; - /** @description The company's legal name. */ + /** + * @nullable + * @description The company's legal name. + */ name?: string | null; - /** @description The Kana variation of the company's legal name (Japan only). */ + /** + * @nullable + * @description The Kana variation of the company's legal name (Japan only). + */ name_kana?: string | null; - /** @description The Kanji variation of the company's legal name (Japan only). */ + /** + * @nullable + * @description The Kanji variation of the company's legal name (Japan only). + */ name_kanji?: string | null; /** @description Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). */ owners_provided?: boolean; - /** @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ + /** + * @nullable + * @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. + */ ownership_declaration?: components["schemas"]["legal_entity_ubo_declaration"] | null; /** @enum {string} */ ownership_exemption_reason?: "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; - /** @description The company's phone number (used for verification). */ + /** + * @nullable + * @description The company's phone number (used for verification). + */ phone?: string | null; /** * @description The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. @@ -17462,7 +19880,10 @@ export interface components { tax_id_registrar?: string; /** @description Whether the company's business VAT number was provided. */ vat_id_provided?: boolean; - /** @description Information on the verification state of the company. */ + /** + * @nullable + * @description Information on the verification state of the company. + */ verification?: components["schemas"]["legal_entity_company_verification"] | null; }; /** LegalEntityCompanyVerification */ @@ -17471,60 +19892,118 @@ export interface components { }; /** LegalEntityCompanyVerificationDocument */ legal_entity_company_verification_document: { - /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ + /** + * @nullable + * @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. + */ back?: (string | components["schemas"]["file"]) | null; - /** @description A user-displayable string describing the verification state of this document. */ + /** + * @nullable + * @description A user-displayable string describing the verification state of this document. + */ details?: string | null; - /** @description One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document. */ + /** + * @nullable + * @description One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document. + */ details_code?: string | null; - /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ + /** + * @nullable + * @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. + */ front?: (string | components["schemas"]["file"]) | null; }; /** LegalEntityDirectorshipDeclaration */ legal_entity_directorship_declaration: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the directorship declaration attestation was made. + * @format unix-time */ date?: number | null; - /** @description The IP address from which the directorship declaration attestation was made. */ + /** + * @nullable + * @description The IP address from which the directorship declaration attestation was made. + */ ip?: string | null; - /** @description The user-agent string from the browser where the directorship declaration attestation was made. */ + /** + * @nullable + * @description The user-agent string from the browser where the directorship declaration attestation was made. + */ user_agent?: string | null; }; /** LegalEntityDOB */ legal_entity_dob: { - /** @description The day of birth, between 1 and 31. */ + /** + * @nullable + * @description The day of birth, between 1 and 31. + */ day?: number | null; - /** @description The month of birth, between 1 and 12. */ + /** + * @nullable + * @description The month of birth, between 1 and 12. + */ month?: number | null; - /** @description The four-digit year of birth. */ + /** + * @nullable + * @description The four-digit year of birth. + */ year?: number | null; }; /** LegalEntityJapanAddress */ legal_entity_japan_address: { - /** @description City/Ward. */ + /** + * @nullable + * @description City/Ward. + */ city?: string | null; - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; - /** @description Block/Building number. */ + /** + * @nullable + * @description Block/Building number. + */ line1?: string | null; - /** @description Building details. */ + /** + * @nullable + * @description Building details. + */ line2?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ postal_code?: string | null; - /** @description Prefecture. */ + /** + * @nullable + * @description Prefecture. + */ state?: string | null; - /** @description Town/cho-me. */ + /** + * @nullable + * @description Town/cho-me. + */ town?: string | null; }; /** LegalEntityPersonVerification */ legal_entity_person_verification: { - /** @description A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. */ + /** + * @nullable + * @description A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + */ additional_document?: components["schemas"]["legal_entity_person_verification_document"] | null; - /** @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ + /** + * @nullable + * @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". + */ details?: string | null; - /** @description One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. */ + /** + * @nullable + * @description One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. + */ details_code?: string | null; document?: components["schemas"]["legal_entity_person_verification_document"]; /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ @@ -17532,25 +20011,44 @@ export interface components { }; /** LegalEntityPersonVerificationDocument */ legal_entity_person_verification_document: { - /** @description The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** + * @nullable + * @description The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + */ back?: (string | components["schemas"]["file"]) | null; - /** @description A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read". */ + /** + * @nullable + * @description A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read". + */ details?: string | null; - /** @description One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document. */ + /** + * @nullable + * @description One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document. + */ details_code?: string | null; - /** @description The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** + * @nullable + * @description The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + */ front?: (string | components["schemas"]["file"]) | null; }; /** LegalEntityUBODeclaration */ legal_entity_ubo_declaration: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the beneficial owner attestation was made. + * @format unix-time */ date?: number | null; - /** @description The IP address from which the beneficial owner attestation was made. */ + /** + * @nullable + * @description The IP address from which the beneficial owner attestation was made. + */ ip?: string | null; - /** @description The user-agent string from the browser where the beneficial owner attestation was made. */ + /** + * @nullable + * @description The user-agent string from the browser where the beneficial owner attestation was made. + */ user_agent?: string | null; }; /** @@ -17562,16 +20060,25 @@ export interface components { line_item: { /** @description The amount, in cents (or local equivalent). */ amount: number; - /** @description The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. + */ amount_excluding_tax?: number | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description The amount of discount calculated per discount for this line item. */ + /** + * @nullable + * @description The amount of discount calculated per discount for this line item. + */ discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; /** @description If true, discounts will apply to this line item. Always false for prorations. */ discountable: boolean; @@ -17579,7 +20086,10 @@ export interface components { discounts: (string | components["schemas"]["discount"])[]; /** @description Unique identifier for the object. */ id: string; - /** @description The ID of the invoice that contains this line item. */ + /** + * @nullable + * @description The ID of the invoice that contains this line item. + */ invoice?: string | null; /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ invoice_item?: string | components["schemas"]["invoiceitem"]; @@ -17595,17 +20105,32 @@ export interface components { */ object: "line_item"; period: components["schemas"]["invoice_line_item_period"]; - /** @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item. */ + /** + * @nullable + * @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item. + */ pretax_credit_amounts?: components["schemas"]["invoices_resource_pretax_credit_amount"][] | null; - /** @description The price of the line item. */ + /** + * @nullable + * @description The price of the line item. + */ price?: components["schemas"]["price"] | null; /** @description Whether this is a proration. */ proration: boolean; - /** @description Additional details for proration line items */ + /** + * @nullable + * @description Additional details for proration line items + */ proration_details?: components["schemas"]["invoices_resource_line_items_proration_details"] | null; - /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ + /** + * @nullable + * @description The quantity of the subscription, if the line item is a subscription or a proration. + */ quantity?: number | null; - /** @description The subscription that the invoice item pertains to, if any. */ + /** + * @nullable + * @description The subscription that the invoice item pertains to, if any. + */ subscription?: (string | components["schemas"]["subscription"]) | null; /** @description The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription. */ subscription_item?: string | components["schemas"]["subscription_item"]; @@ -17619,8 +20144,9 @@ export interface components { */ type: "invoiceitem" | "subscription"; /** - * Format: decimal + * @nullable * @description The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts. + * @format decimal */ unit_amount_excluding_tax?: string | null; }; @@ -17636,11 +20162,15 @@ export interface components { amount: number; rate: components["schemas"]["tax_rate"]; /** + * @nullable * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. * @enum {string|null} */ taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in cents (or local equivalent). */ + /** + * @nullable + * @description The amount on which tax is calculated, in cents (or local equivalent). + */ taxable_amount?: number | null; }; /** linked_account_options_us_bank_account */ @@ -17648,7 +20178,10 @@ export interface components { filters?: components["schemas"]["payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters"]; /** @description The list of permissions to request. The `payment_method` permission must be included. */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - /** @description Data features requested to be retrieved upon account creation. */ + /** + * @nullable + * @description Data features requested to be retrieved upon account creation. + */ prefetch?: ("balances" | "ownership" | "transactions")[] | null; /** @description For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ return_url?: string; @@ -17659,8 +20192,8 @@ export interface components { */ login_link: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @@ -17708,7 +20241,10 @@ export interface components { mandate_acss_debit: { /** @description List of Stripe products where this mandate can be selected automatically. */ default_for?: ("invoice" | "subscription")[]; - /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /** + * @nullable + * @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. + */ interval_description?: string | null; /** * @description Payment schedule for the mandate. @@ -17738,6 +20274,7 @@ export interface components { /** @description The unique reference identifying the mandate on the Bacs network. */ reference: string; /** + * @nullable * @description When the mandate is revoked on the Bacs network this field displays the reason for the revocation. * @enum {string|null} */ @@ -17775,9 +20312,15 @@ export interface components { }; /** mandate_paypal */ mandate_paypal: { - /** @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. */ + /** + * @nullable + * @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. + */ billing_agreement_id?: string | null; - /** @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ + /** + * @nullable + * @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. + */ payer_id?: string | null; }; /** mandate_revolut_pay */ @@ -17794,8 +20337,8 @@ export interface components { /** @description The amount of the payment on a single use mandate. */ amount: number; /** - * Format: currency * @description The currency of the payment on a single use mandate. + * @format currency */ currency: string; }; @@ -17811,7 +20354,10 @@ export interface components { networks: { /** @description All available networks for the card. */ available: string[]; - /** @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. */ + /** + * @nullable + * @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. + */ preferred?: string | null; }; /** NotificationEventData */ @@ -17823,18 +20369,30 @@ export interface components { }; /** NotificationEventRequest */ notification_event_request: { - /** @description ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. */ + /** + * @nullable + * @description ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. + */ id?: string | null; - /** @description The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. */ + /** + * @nullable + * @description The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. + */ idempotency_key?: string | null; }; /** offline_acceptance */ offline_acceptance: Record; /** online_acceptance */ online_acceptance: { - /** @description The customer accepts the mandate from this IP address. */ + /** + * @nullable + * @description The customer accepts the mandate from this IP address. + */ ip_address?: string | null; - /** @description The customer accepts the mandate using the user agent of the browser. */ + /** + * @nullable + * @description The customer accepts the mandate using the user agent of the browser. + */ user_agent?: string | null; }; /** OutboundPaymentsPaymentMethodDetails */ @@ -17861,20 +20419,31 @@ export interface components { /** outbound_payments_payment_method_details_us_bank_account */ outbound_payments_payment_method_details_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; @@ -17883,7 +20452,10 @@ export interface components { * @enum {string} */ network: "ach" | "us_domestic_wire"; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; }; /** OutboundTransfersPaymentMethodDetails */ @@ -17910,20 +20482,31 @@ export interface components { /** outbound_transfers_payment_method_details_us_bank_account */ outbound_transfers_payment_method_details_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; @@ -17932,7 +20515,10 @@ export interface components { * @enum {string} */ network: "ach" | "us_domestic_wire"; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; }; /** PackageDimensions */ @@ -17980,7 +20566,10 @@ export interface components { * @enum {string} */ allow_redirects?: "always" | "never"; - /** @description Automatically calculates compatible payment methods */ + /** + * @nullable + * @description Automatically calculates compatible payment methods + */ enabled?: boolean | null; }; /** PaymentFlowsInstallmentOptions */ @@ -17994,9 +20583,15 @@ export interface components { payment_flows_private_payment_methods_alipay_details: { /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ buyer_id?: string; - /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. + */ fingerprint?: string | null; - /** @description Transaction ID of this particular Alipay transaction. */ + /** + * @nullable + * @description Transaction ID of this particular Alipay transaction. + */ transaction_id?: string | null; }; /** PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization */ @@ -18062,11 +20657,20 @@ export interface components { }; /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ payment_flows_private_payment_methods_klarna_dob: { - /** @description The day of birth, between 1 and 31. */ + /** + * @nullable + * @description The day of birth, between 1 and 31. + */ day?: number | null; - /** @description The month of birth, between 1 and 12. */ + /** + * @nullable + * @description The month of birth, between 1 and 12. + */ month?: number | null; - /** @description The four-digit year of birth. */ + /** + * @nullable + * @description The four-digit year of birth. + */ year?: number | null; }; /** PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions */ @@ -18120,18 +20724,29 @@ export interface components { amount_details?: components["schemas"]["payment_flows_amount_details"] | components["schemas"]["payment_flows_amount_details_client"]; /** @description Amount that this PaymentIntent collects. */ amount_received?: number; - /** @description ID of the Connect application that created the PaymentIntent. */ + /** + * @nullable + * @description ID of the Connect application that created the PaymentIntent. + */ application?: (string | components["schemas"]["application"]) | null; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** + * @nullable + * @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + */ application_fee_amount?: number | null; - /** @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) */ + /** + * @nullable + * @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) + */ automatic_payment_methods?: components["schemas"]["payment_flows_automatic_payment_methods_payment_intent"] | null; /** - * Format: unix-time + * @nullable * @description Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. + * @format unix-time */ canceled_at?: number | null; /** + * @nullable * @description Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`). * @enum {string|null} */ @@ -18142,6 +20757,7 @@ export interface components { */ capture_method: "automatic" | "automatic_async" | "manual"; /** + * @nullable * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. @@ -18155,16 +20771,17 @@ export interface components { */ confirmation_method: "automatic" | "manual"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** + * @nullable * @description ID of the Customer this PaymentIntent belongs to, if one exists. * * Payment methods attached to other Customers cannot be used with this PaymentIntent. @@ -18172,15 +20789,27 @@ export interface components { * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description Unique identifier for the object. */ id: string; - /** @description ID of the invoice that created this PaymentIntent, if it exists. */ + /** + * @nullable + * @description ID of the invoice that created this PaymentIntent, if it exists. + */ invoice?: (string | components["schemas"]["invoice"]) | null; - /** @description The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. */ + /** + * @nullable + * @description The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. + */ last_payment_error?: components["schemas"]["api_errors"] | null; - /** @description ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. */ + /** + * @nullable + * @description ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. + */ latest_charge?: (string | components["schemas"]["charge"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -18188,30 +20817,55 @@ export interface components { metadata?: { [key: string]: string; }; - /** @description If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. */ + /** + * @nullable + * @description If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. + */ next_action?: components["schemas"]["payment_intent_next_action"] | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "payment_intent"; - /** @description The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ + /** + * @nullable + * @description The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description ID of the payment method used in this PaymentIntent. */ + /** + * @nullable + * @description ID of the payment method used in this PaymentIntent. + */ payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent. */ + /** + * @nullable + * @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent. + */ payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; - /** @description Payment-method-specific configuration for this PaymentIntent. */ + /** + * @nullable + * @description Payment-method-specific configuration for this PaymentIntent. + */ payment_method_options?: components["schemas"]["payment_intent_payment_method_options"] | null; /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ payment_method_types: string[]; - /** @description If present, this property tells you about the processing state of the payment. */ + /** + * @nullable + * @description If present, this property tells you about the processing state of the payment. + */ processing?: components["schemas"]["payment_intent_processing"] | null; - /** @description Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ + /** + * @nullable + * @description Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). + */ receipt_email?: string | null; - /** @description ID of the review associated with this PaymentIntent, if any. */ + /** + * @nullable + * @description ID of the review associated with this PaymentIntent, if any. + */ review?: (string | components["schemas"]["review"]) | null; /** + * @nullable * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. @@ -18222,24 +20876,37 @@ export interface components { * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; - /** @description Shipping information for this PaymentIntent. */ + /** + * @nullable + * @description Shipping information for this PaymentIntent. + */ shipping?: components["schemas"]["shipping"] | null; /** + * @nullable * @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). * * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string | null; - /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ + /** + * @nullable + * @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. + */ statement_descriptor_suffix?: string | null; /** * @description Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses). * @enum {string} */ status: "canceled" | "processing" | "requires_action" | "requires_capture" | "requires_confirmation" | "requires_payment_method" | "succeeded"; - /** @description The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** + * @nullable + * @description The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + */ transfer_data?: components["schemas"]["transfer_data"] | null; - /** @description A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). */ + /** + * @nullable + * @description A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). + */ transfer_group?: string | null; }; /** PaymentIntentCardProcessing */ @@ -18272,37 +20939,63 @@ export interface components { }; /** PaymentIntentNextActionAlipayHandleRedirect */ payment_intent_next_action_alipay_handle_redirect: { - /** @description The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App. */ + /** + * @nullable + * @description The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App. + */ native_data?: string | null; - /** @description The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. */ + /** + * @nullable + * @description The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. + */ native_url?: string | null; - /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ + /** + * @nullable + * @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. + */ return_url?: string | null; - /** @description The URL you must redirect your customer to in order to authenticate the payment. */ + /** + * @nullable + * @description The URL you must redirect your customer to in order to authenticate the payment. + */ url?: string | null; }; /** payment_intent_next_action_boleto */ payment_intent_next_action_boleto: { /** - * Format: unix-time + * @nullable * @description The timestamp after which the boleto expires. + * @format unix-time */ expires_at?: number | null; - /** @description The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. */ + /** + * @nullable + * @description The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. + */ hosted_voucher_url?: string | null; - /** @description The boleto number. */ + /** + * @nullable + * @description The boleto number. + */ number?: string | null; - /** @description The URL to the downloadable boleto voucher PDF. */ + /** + * @nullable + * @description The URL to the downloadable boleto voucher PDF. + */ pdf?: string | null; }; /** PaymentIntentNextActionCardAwaitNotification */ payment_intent_next_action_card_await_notification: { /** - * Format: unix-time + * @nullable * @description The time that payment will be attempted. If customer approval is required, they need to provide approval before this time. + * @format unix-time */ charge_attempt_at?: number | null; - /** @description For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required. */ + /** + * @nullable + * @description For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required. + */ customer_approval_required?: boolean | null; }; /** PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode */ @@ -18316,8 +21009,8 @@ export interface components { /** PaymentIntentNextActionCashappQRCode */ payment_intent_next_action_cashapp_qr_code: { /** - * Format: unix-time * @description The date (unix timestamp) when the QR code expires. + * @format unix-time */ expires_at: number; /** @description The image_url_png string used to render QR code */ @@ -18327,18 +21020,28 @@ export interface components { }; /** PaymentIntentNextActionDisplayBankTransferInstructions */ payment_intent_next_action_display_bank_transfer_instructions: { - /** @description The remaining amount that needs to be transferred to complete the payment. */ + /** + * @nullable + * @description The remaining amount that needs to be transferred to complete the payment. + */ amount_remaining?: number | null; /** - * Format: currency + * @nullable * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string | null; /** @description A list of financial addresses that can be used to fund the customer balance */ financial_addresses?: components["schemas"]["funding_instructions_bank_transfer_financial_address"][]; - /** @description A link to a hosted page that guides your customer through completing the transfer. */ + /** + * @nullable + * @description A link to a hosted page that guides your customer through completing the transfer. + */ hosted_instructions_url?: string | null; - /** @description A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer. */ + /** + * @nullable + * @description A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer. + */ reference?: string | null; /** * @description Type of bank transfer @@ -18348,38 +21051,58 @@ export interface components { }; /** PaymentIntentNextActionDisplayMultibancoDetails */ payment_intent_next_action_display_multibanco_details: { - /** @description Entity number associated with this Multibanco payment. */ + /** + * @nullable + * @description Entity number associated with this Multibanco payment. + */ entity?: string | null; /** - * Format: unix-time + * @nullable * @description The timestamp at which the Multibanco voucher expires. + * @format unix-time */ expires_at?: number | null; - /** @description The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher. */ + /** + * @nullable + * @description The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher. + */ hosted_voucher_url?: string | null; - /** @description Reference number associated with this Multibanco payment. */ + /** + * @nullable + * @description Reference number associated with this Multibanco payment. + */ reference?: string | null; }; /** PaymentIntentNextActionDisplayOxxoDetails */ payment_intent_next_action_display_oxxo_details: { /** - * Format: unix-time + * @nullable * @description The timestamp after which the OXXO voucher expires. + * @format unix-time */ expires_after?: number | null; - /** @description The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. */ + /** + * @nullable + * @description The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. + */ hosted_voucher_url?: string | null; - /** @description OXXO reference number. */ + /** + * @nullable + * @description OXXO reference number. + */ number?: string | null; }; /** payment_intent_next_action_konbini */ payment_intent_next_action_konbini: { /** - * Format: unix-time * @description The timestamp at which the pending Konbini payment expires. + * @format unix-time */ expires_at: number; - /** @description The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher. */ + /** + * @nullable + * @description The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher. + */ hosted_voucher_url?: string | null; stores: components["schemas"]["payment_intent_next_action_konbini_stores"]; }; @@ -18413,20 +21136,35 @@ export interface components { }; /** payment_intent_next_action_konbini_stores */ payment_intent_next_action_konbini_stores: { - /** @description FamilyMart instruction details. */ + /** + * @nullable + * @description FamilyMart instruction details. + */ familymart?: components["schemas"]["payment_intent_next_action_konbini_familymart"] | null; - /** @description Lawson instruction details. */ + /** + * @nullable + * @description Lawson instruction details. + */ lawson?: components["schemas"]["payment_intent_next_action_konbini_lawson"] | null; - /** @description Ministop instruction details. */ + /** + * @nullable + * @description Ministop instruction details. + */ ministop?: components["schemas"]["payment_intent_next_action_konbini_ministop"] | null; - /** @description Seicomart instruction details. */ + /** + * @nullable + * @description Seicomart instruction details. + */ seicomart?: components["schemas"]["payment_intent_next_action_konbini_seicomart"] | null; }; /** PaymentIntentNextActionPaynowDisplayQrCode */ payment_intent_next_action_paynow_display_qr_code: { /** @description The raw data string used to generate QR code, it should be used together with QR code library. */ data: string; - /** @description The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code. */ + /** + * @nullable + * @description The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code. + */ hosted_instructions_url?: string | null; /** @description The image_url_png string used to render QR code */ image_url_png: string; @@ -18459,9 +21197,15 @@ export interface components { }; /** PaymentIntentNextActionRedirectToUrl */ payment_intent_next_action_redirect_to_url: { - /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ + /** + * @nullable + * @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. + */ return_url?: string | null; - /** @description The URL you must redirect your customer to in order to authenticate the payment. */ + /** + * @nullable + * @description The URL you must redirect your customer to in order to authenticate the payment. + */ url?: string | null; }; /** PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode */ @@ -18482,13 +21226,14 @@ export interface components { /** PaymentIntentNextActionVerifyWithMicrodeposits */ payment_intent_next_action_verify_with_microdeposits: { /** - * Format: unix-time * @description The timestamp when the microdeposits are expected to land. + * @format unix-time */ arrival_date: number; /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ hosted_verification_url: string; /** + * @nullable * @description The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. * @enum {string|null} */ @@ -18649,14 +21394,19 @@ export interface components { */ capture_method?: "manual"; /** + * @nullable * @description Installment details for this payment (Mexico only). * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ installments?: components["schemas"]["payment_method_options_card_installments"] | null; - /** @description Configuration options for setting up an eMandate for cards issued in India. */ + /** + * @nullable + * @description Configuration options for setting up an eMandate for cards issued in India. + */ mandate_options?: components["schemas"]["payment_method_options_card_mandate_options"] | null; /** + * @nullable * @description Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time. * @enum {string|null} */ @@ -18682,6 +21432,7 @@ export interface components { */ request_overcapture?: "if_available" | "never"; /** + * @nullable * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ @@ -18741,14 +21492,19 @@ export interface components { payment_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ custom_mandate_url?: string; - /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /** + * @nullable + * @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. + */ interval_description?: string | null; /** + * @nullable * @description Payment schedule for the mandate. * @enum {string|null} */ payment_schedule?: "combined" | "interval" | "sporadic" | null; /** + * @nullable * @description Transaction type of the mandate. * @enum {string|null} */ @@ -18800,7 +21556,10 @@ export interface components { }; /** payment_intent_payment_method_options_swish */ payment_intent_payment_method_options_swish: { - /** @description A reference for this payment to be displayed in the Swish app. */ + /** + * @nullable + * @description A reference for this payment to be displayed in the Swish app. + */ reference?: string | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -18851,11 +21610,15 @@ export interface components { }; /** PaymentIntentProcessingCustomerNotification */ payment_intent_processing_customer_notification: { - /** @description Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank. */ + /** + * @nullable + * @description Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank. + */ approval_requested?: boolean | null; /** - * Format: unix-time + * @nullable * @description If customer approval is required, they need to provide approval before this time. + * @format unix-time */ completes_at?: number | null; }; @@ -18903,11 +21666,20 @@ export interface components { after_completion: components["schemas"]["payment_links_resource_after_completion"]; /** @description Whether user redeemable promotion codes are enabled. */ allow_promotion_codes: boolean; - /** @description The ID of the Connect application that created the Payment Link. */ + /** + * @nullable + * @description The ID of the Connect application that created the Payment Link. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. */ + /** + * @nullable + * @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. + */ application_fee_amount?: number | null; - /** @description This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. */ + /** + * @nullable + * @description This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. + */ application_fee_percent?: number | null; automatic_tax: components["schemas"]["payment_links_resource_automatic_tax"]; /** @@ -18915,11 +21687,14 @@ export interface components { * @enum {string} */ billing_address_collection: "auto" | "required"; - /** @description When set, provides configuration to gather active consent from customers. */ + /** + * @nullable + * @description When set, provides configuration to gather active consent from customers. + */ consent_collection?: components["schemas"]["payment_links_resource_consent_collection"] | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ @@ -18932,9 +21707,15 @@ export interface components { customer_creation: "always" | "if_required"; /** @description Unique identifier for the object. */ id: string; - /** @description The custom message to be displayed to a customer when a payment link is no longer active. */ + /** + * @nullable + * @description The custom message to be displayed to a customer when a payment link is no longer active. + */ inactive_message?: string | null; - /** @description Configuration for creating invoice for payment mode payment links. */ + /** + * @nullable + * @description Configuration for creating invoice for payment mode payment links. + */ invoice_creation?: components["schemas"]["payment_links_resource_invoice_creation"] | null; /** * PaymentLinksResourceListLineItems @@ -18964,21 +21745,36 @@ export interface components { * @enum {string} */ object: "payment_link"; - /** @description The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. */ + /** + * @nullable + * @description The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description Indicates the parameters to be passed to PaymentIntent creation during checkout. */ + /** + * @nullable + * @description Indicates the parameters to be passed to PaymentIntent creation during checkout. + */ payment_intent_data?: components["schemas"]["payment_links_resource_payment_intent_data"] | null; /** * @description Configuration for collecting a payment method during checkout. Defaults to `always`. * @enum {string} */ payment_method_collection: "always" | "if_required"; - /** @description The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ + /** + * @nullable + * @description The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). + */ payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; - /** @description Settings that restrict the usage of a payment link. */ + /** + * @nullable + * @description Settings that restrict the usage of a payment link. + */ restrictions?: components["schemas"]["payment_links_resource_restrictions"] | null; - /** @description Configuration for collecting the customer's shipping address. */ + /** + * @nullable + * @description Configuration for collecting the customer's shipping address. + */ shipping_address_collection?: components["schemas"]["payment_links_resource_shipping_address_collection"] | null; /** @description The shipping rate options applied to the session. */ shipping_options: components["schemas"]["payment_links_resource_shipping_option"][]; @@ -18987,10 +21783,16 @@ export interface components { * @enum {string} */ submit_type: "auto" | "book" | "donate" | "pay" | "subscribe"; - /** @description When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. */ + /** + * @nullable + * @description When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. + */ subscription_data?: components["schemas"]["payment_links_resource_subscription_data"] | null; tax_id_collection: components["schemas"]["payment_links_resource_tax_id_collection"]; - /** @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. */ + /** + * @nullable + * @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. + */ transfer_data?: components["schemas"]["payment_links_resource_transfer_data"] | null; /** @description The public URL that can be shared with customers. */ url: string; @@ -19009,7 +21811,10 @@ export interface components { payment_links_resource_automatic_tax: { /** @description If `true`, tax will be calculated automatically using the customer's location. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; }; /** PaymentLinksResourceCompletedSessions */ @@ -19021,7 +21826,10 @@ export interface components { }; /** PaymentLinksResourceCompletionBehaviorConfirmationPage */ payment_links_resource_completion_behavior_confirmation_page: { - /** @description The custom message that is displayed to the customer after the purchase is complete. */ + /** + * @nullable + * @description The custom message that is displayed to the customer after the purchase is complete. + */ custom_message?: string | null; }; /** PaymentLinksResourceCompletionBehaviorRedirect */ @@ -19031,14 +21839,19 @@ export interface components { }; /** PaymentLinksResourceConsentCollection */ payment_links_resource_consent_collection: { - /** @description Settings related to the payment method reuse text shown in the Checkout UI. */ + /** + * @nullable + * @description Settings related to the payment method reuse text shown in the Checkout UI. + */ payment_method_reuse_agreement?: components["schemas"]["payment_links_resource_payment_method_reuse_agreement"] | null; /** + * @nullable * @description If set to `auto`, enables the collection of customer consent for promotional communications. * @enum {string|null} */ promotions?: "auto" | "none" | null; /** + * @nullable * @description If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service. * @enum {string|null} */ @@ -19074,7 +21887,10 @@ export interface components { }; /** PaymentLinksResourceCustomFieldsLabel */ payment_links_resource_custom_fields_label: { - /** @description Custom text for the label, displayed to the customer. Up to 50 characters. */ + /** + * @nullable + * @description Custom text for the label, displayed to the customer. Up to 50 characters. + */ custom?: string | null; /** * @description The type of the label. @@ -19084,27 +21900,51 @@ export interface components { }; /** PaymentLinksResourceCustomFieldsNumeric */ payment_links_resource_custom_fields_numeric: { - /** @description The maximum character length constraint for the customer's input. */ + /** + * @nullable + * @description The maximum character length constraint for the customer's input. + */ maximum_length?: number | null; - /** @description The minimum character length requirement for the customer's input. */ + /** + * @nullable + * @description The minimum character length requirement for the customer's input. + */ minimum_length?: number | null; }; /** PaymentLinksResourceCustomFieldsText */ payment_links_resource_custom_fields_text: { - /** @description The maximum character length constraint for the customer's input. */ + /** + * @nullable + * @description The maximum character length constraint for the customer's input. + */ maximum_length?: number | null; - /** @description The minimum character length requirement for the customer's input. */ + /** + * @nullable + * @description The minimum character length requirement for the customer's input. + */ minimum_length?: number | null; }; /** PaymentLinksResourceCustomText */ payment_links_resource_custom_text: { - /** @description Custom text that should be displayed after the payment confirmation button. */ + /** + * @nullable + * @description Custom text that should be displayed after the payment confirmation button. + */ after_submit?: components["schemas"]["payment_links_resource_custom_text_position"] | null; - /** @description Custom text that should be displayed alongside shipping address collection. */ + /** + * @nullable + * @description Custom text that should be displayed alongside shipping address collection. + */ shipping_address?: components["schemas"]["payment_links_resource_custom_text_position"] | null; - /** @description Custom text that should be displayed alongside the payment confirmation button. */ + /** + * @nullable + * @description Custom text that should be displayed alongside the payment confirmation button. + */ submit?: components["schemas"]["payment_links_resource_custom_text_position"] | null; - /** @description Custom text that should be displayed in place of the default terms of service agreement text. */ + /** + * @nullable + * @description Custom text that should be displayed in place of the default terms of service agreement text. + */ terms_of_service_acceptance?: components["schemas"]["payment_links_resource_custom_text_position"] | null; }; /** PaymentLinksResourceCustomTextPosition */ @@ -19116,51 +21956,89 @@ export interface components { payment_links_resource_invoice_creation: { /** @description Enable creating an invoice on successful payment. */ enabled: boolean; - /** @description Configuration for the invoice. Default invoice values will be used if unspecified. */ + /** + * @nullable + * @description Configuration for the invoice. Default invoice values will be used if unspecified. + */ invoice_data?: components["schemas"]["payment_links_resource_invoice_settings"] | null; }; /** PaymentLinksResourceInvoiceSettings */ payment_links_resource_invoice_settings: { - /** @description The account tax IDs associated with the invoice. */ + /** + * @nullable + * @description The account tax IDs associated with the invoice. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; - /** @description A list of up to 4 custom fields to be displayed on the invoice. */ + /** + * @nullable + * @description A list of up to 4 custom fields to be displayed on the invoice. + */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Footer to be displayed on the invoice. */ + /** + * @nullable + * @description Footer to be displayed on the invoice. + */ footer?: string | null; - /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + /** + * @nullable + * @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. + */ issuer?: components["schemas"]["connect_account_reference"] | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description Options for invoice PDF rendering. */ + /** + * @nullable + * @description Options for invoice PDF rendering. + */ rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; }; /** PaymentLinksResourcePaymentIntentData */ payment_links_resource_payment_intent_data: { /** + * @nullable * @description Indicates when the funds will be captured from the customer's account. * @enum {string|null} */ capture_method?: "automatic" | "automatic_async" | "manual" | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @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; }; /** + * @nullable * @description Indicates that you intend to make future payments with the payment method collected during checkout. * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; - /** @description For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. */ + /** + * @nullable + * @description For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. + */ statement_descriptor?: string | null; - /** @description For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. */ + /** + * @nullable + * @description For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. + */ statement_descriptor_suffix?: string | null; - /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ + /** + * @nullable + * @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. + */ transfer_group?: string | null; }; /** PaymentLinksResourcePaymentMethodReuseAgreement */ @@ -19196,16 +22074,25 @@ 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 for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. + */ description?: string | null; invoice_settings: components["schemas"]["payment_links_resource_subscription_data_invoice_settings"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. */ metadata: { [key: string]: string; }; - /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ + /** + * @nullable + * @description Integer representing the number of trial period days before the customer is charged for the first time. + */ trial_period_days?: number | null; - /** @description Settings related to subscription trials. */ + /** + * @nullable + * @description Settings related to subscription trials. + */ trial_settings?: components["schemas"]["subscriptions_trials_resource_trial_settings"] | null; }; /** PaymentLinksResourceSubscriptionDataInvoiceSettings */ @@ -19221,7 +22108,10 @@ export interface components { }; /** PaymentLinksResourceTransferData */ payment_links_resource_transfer_data: { - /** @description The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ + /** + * @nullable + * @description The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + */ amount?: number | null; /** @description The connected account receiving the transfer. */ destination: string | components["schemas"]["account"]; @@ -19256,11 +22146,14 @@ export interface components { card_present?: components["schemas"]["payment_method_card_present"]; cashapp?: components["schemas"]["payment_method_cashapp"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. */ + /** + * @nullable + * @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. + */ customer?: (string | components["schemas"]["customer"]) | null; customer_balance?: components["schemas"]["payment_method_customer_balance"]; eps?: components["schemas"]["payment_method_eps"]; @@ -19278,7 +22171,10 @@ export interface components { link?: components["schemas"]["payment_method_link"]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -19316,15 +22212,30 @@ export interface components { }; /** payment_method_acss_debit */ payment_method_acss_debit: { - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Institution number of the bank account. */ + /** + * @nullable + * @description Institution number of the bank account. + */ institution_number?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description Transit number of the bank account. */ + /** + * @nullable + * @description Transit number of the bank account. + */ transit_number?: string | null; }; /** payment_method_affirm */ @@ -19337,20 +22248,38 @@ export interface components { payment_method_amazon_pay: Record; /** payment_method_au_becs_debit */ payment_method_au_becs_debit: { - /** @description Six-digit number identifying bank and branch associated with this bank account. */ + /** + * @nullable + * @description Six-digit number identifying bank and branch associated with this bank account. + */ bsb_number?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; }; /** payment_method_bacs_debit */ payment_method_bacs_debit: { - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description Sort code of the bank account. (e.g., `10-20-30`) */ + /** + * @nullable + * @description Sort code of the bank account. (e.g., `10-20-30`) + */ sort_code?: string | null; }; /** payment_method_bancontact */ @@ -19366,17 +22295,27 @@ export interface components { payment_method_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand: string; - /** @description Checks on Card address and CVC if provided. */ + /** + * @nullable + * @description Checks on Card address and CVC if provided. + */ checks?: components["schemas"]["payment_method_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. */ + /** + * @nullable + * @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 The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. */ + /** + * @nullable + * @description The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. + */ display_brand?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* @@ -19384,75 +22323,141 @@ export interface components { fingerprint?: string | null; /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ funding: string; - /** @description Details of the original PaymentMethod that created this object. */ + /** + * @nullable + * @description Details of the original PaymentMethod that created this object. + */ generated_from?: components["schemas"]["payment_method_card_generated_card"] | null; /** @description The last four digits of the card. */ last4: string; - /** @description Contains information about card networks that can be used to process the payment. */ + /** + * @nullable + * @description Contains information about card networks that can be used to process the payment. + */ networks?: components["schemas"]["networks"] | null; /** + * @nullable * @description Status of a card based on the card issuer. * @enum {string|null} */ regulated_status?: "regulated" | "unregulated" | null; - /** @description Contains details on how this Card may be used for 3D Secure authentication. */ + /** + * @nullable + * @description Contains details on how this Card may be used for 3D Secure authentication. + */ three_d_secure_usage?: components["schemas"]["three_d_secure_usage"] | null; - /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ + /** + * @nullable + * @description If this Card is part of a card wallet, this contains the details of the card wallet. + */ wallet?: components["schemas"]["payment_method_card_wallet"] | null; }; /** payment_method_card_checks */ payment_method_card_checks: { - /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. + */ cvc_check?: string | null; }; /** payment_method_card_generated_card */ payment_method_card_generated_card: { - /** @description The charge that created this object. */ + /** + * @nullable + * @description The charge that created this object. + */ charge?: string | null; - /** @description Transaction-specific details of the payment method used in the payment. */ + /** + * @nullable + * @description Transaction-specific details of the payment method used in the payment. + */ payment_method_details?: components["schemas"]["card_generated_from_payment_method_details"] | null; - /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ + /** + * @nullable + * @description The ID of the SetupAttempt that generated this PaymentMethod, if any. + */ setup_attempt?: (string | components["schemas"]["setup_attempt"]) | null; }; /** payment_method_card_present */ payment_method_card_present: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ brand?: string | null; - /** @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ + /** + * @nullable + * @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. + */ brand_product?: string | null; - /** @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /** + * @nullable + * @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. + */ cardholder_name?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; - /** @description A high-level description of the type of cards issued in this range. */ + /** + * @nullable + * @description A high-level description of the type of cards issued in this range. + */ description?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description The name of the card's issuing bank. */ + /** + * @nullable + * @description The name of the card's issuing bank. + */ issuer?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Contains information about card networks that can be used to process the payment. */ + /** + * @nullable + * @description Contains information about card networks that can be used to process the payment. + */ networks?: components["schemas"]["payment_method_card_present_networks"] | null; - /** @description Details about payment methods collected offline. */ + /** + * @nullable + * @description Details about payment methods collected offline. + */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. + */ preferred_locales?: string[] | null; /** + * @nullable * @description How card details were read in this transaction. * @enum {string|null} */ @@ -19463,14 +22468,20 @@ export interface components { payment_method_card_present_networks: { /** @description All available networks for the card. */ available: string[]; - /** @description The preferred network for the card. */ + /** + * @nullable + * @description The preferred network for the card. + */ preferred?: string | null; }; /** payment_method_card_wallet */ payment_method_card_wallet: { amex_express_checkout?: components["schemas"]["payment_method_card_wallet_amex_express_checkout"]; apple_pay?: components["schemas"]["payment_method_card_wallet_apple_pay"]; - /** @description (For tokenized numbers only.) The last four digits of the device account number. */ + /** + * @nullable + * @description (For tokenized numbers only.) The last four digits of the device account number. + */ dynamic_last4?: string | null; google_pay?: components["schemas"]["payment_method_card_wallet_google_pay"]; link?: components["schemas"]["payment_method_card_wallet_link"]; @@ -19493,45 +22504,81 @@ export interface components { payment_method_card_wallet_link: Record; /** payment_method_card_wallet_masterpass */ payment_method_card_wallet_masterpass: { - /** @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ billing_address?: components["schemas"]["address"] | null; - /** @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ email?: string | null; - /** @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ name?: string | null; - /** @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ shipping_address?: components["schemas"]["address"] | null; }; /** payment_method_card_wallet_samsung_pay */ payment_method_card_wallet_samsung_pay: Record; /** payment_method_card_wallet_visa_checkout */ payment_method_card_wallet_visa_checkout: { - /** @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ billing_address?: components["schemas"]["address"] | null; - /** @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ email?: string | null; - /** @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ name?: string | null; - /** @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ shipping_address?: components["schemas"]["address"] | null; }; /** payment_method_cashapp */ payment_method_cashapp: { - /** @description A unique and immutable identifier assigned by Cash App to every buyer. */ + /** + * @nullable + * @description A unique and immutable identifier assigned by Cash App to every buyer. + */ buyer_id?: string | null; - /** @description A public identifier for buyers using Cash App. */ + /** + * @nullable + * @description A public identifier for buyers using Cash App. + */ cashtag?: string | null; }; /** PaymentMethodConfigBizPaymentMethodConfigurationDetails */ payment_method_config_biz_payment_method_configuration_details: { /** @description ID of the payment method configuration used. */ id: string; - /** @description ID of the parent payment method configuration used. */ + /** + * @nullable + * @description ID of the parent payment method configuration used. + */ parent?: string | null; }; /** PaymentMethodConfigResourceDisplayPreference */ payment_method_config_resource_display_preference: { - /** @description For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. */ + /** + * @nullable + * @description For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + */ overridable?: boolean | null; /** * @description The account's display preference. @@ -19577,7 +22624,10 @@ export interface components { alma?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; amazon_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; apple_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; - /** @description For child configs, the Connect application associated with the configuration. */ + /** + * @nullable + * @description For child configs, the Connect application associated with the configuration. + */ application?: string | null; au_becs_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; bacs_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -19615,7 +22665,10 @@ export interface components { object: "payment_method_configuration"; oxxo?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; p24?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; - /** @description For child configs, the configuration's parent configuration. */ + /** + * @nullable + * @description For child configs, the configuration's parent configuration. + */ parent?: string | null; pay_by_bank?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; paynow?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -19693,58 +22746,110 @@ export interface components { }; /** payment_method_details_ach_credit_transfer */ payment_method_details_ach_credit_transfer: { - /** @description Account number to transfer funds to. */ + /** + * @nullable + * @description Account number to transfer funds to. + */ account_number?: string | null; - /** @description Name of the bank associated with the routing number. */ + /** + * @nullable + * @description Name of the bank associated with the routing number. + */ bank_name?: string | null; - /** @description Routing transit number for the bank account to transfer funds to. */ + /** + * @nullable + * @description Routing transit number for the bank account to transfer funds to. + */ routing_number?: string | null; - /** @description SWIFT code of the bank associated with the routing number. */ + /** + * @nullable + * @description SWIFT code of the bank associated with the routing number. + */ swift_code?: string | null; }; /** payment_method_details_ach_debit */ payment_method_details_ach_debit: { /** + * @nullable * @description Type of entity that holds the account. This can be either `individual` or `company`. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description Routing transit number of the bank account. */ + /** + * @nullable + * @description Routing transit number of the bank account. + */ routing_number?: string | null; }; /** payment_method_details_acss_debit */ payment_method_details_acss_debit: { - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Institution number of the bank account */ + /** + * @nullable + * @description Institution number of the bank account + */ institution_number?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string; - /** @description Transit number of the bank account. */ + /** + * @nullable + * @description Transit number of the bank account. + */ transit_number?: string | null; }; /** payment_method_details_affirm */ payment_method_details_affirm: { - /** @description The Affirm transaction ID associated with this payment. */ + /** + * @nullable + * @description The Affirm transaction ID associated with this payment. + */ transaction_id?: string | null; }; /** payment_method_details_afterpay_clearpay */ payment_method_details_afterpay_clearpay: { - /** @description The Afterpay order ID associated with this payment intent. */ + /** + * @nullable + * @description The Afterpay order ID associated with this payment intent. + */ order_id?: string | null; - /** @description Order identifier shown to the merchant in Afterpay’s online portal. */ + /** + * @nullable + * @description Order identifier shown to the merchant in Afterpay’s online portal. + */ reference?: string | null; }; /** payment_method_details_alma */ @@ -19755,47 +22860,88 @@ export interface components { }; /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { - /** @description Bank-State-Branch number of the bank account. */ + /** + * @nullable + * @description Bank-State-Branch number of the bank account. + */ bsb_number?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string; }; /** payment_method_details_bacs_debit */ payment_method_details_bacs_debit: { - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description ID of the mandate used to make this payment. */ + /** + * @nullable + * @description ID of the mandate used to make this payment. + */ mandate?: string | null; - /** @description Sort code of the bank account. (e.g., `10-20-30`) */ + /** + * @nullable + * @description Sort code of the bank account. (e.g., `10-20-30`) + */ sort_code?: string | null; }; /** payment_method_details_bancontact */ payment_method_details_bancontact: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ preferred_language?: "de" | "en" | "fr" | "nl" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -19803,7 +22949,10 @@ export interface components { }; /** payment_method_details_blik */ payment_method_details_blik: { - /** @description A unique and immutable identifier assigned by BLIK to every buyer. */ + /** + * @nullable + * @description A unique and immutable identifier assigned by BLIK to every buyer. + */ buyer_id?: string | null; }; /** payment_method_details_boleto */ @@ -19813,20 +22962,35 @@ export interface components { }; /** payment_method_details_card */ payment_method_details_card: { - /** @description The authorized amount. */ + /** + * @nullable + * @description The authorized amount. + */ amount_authorized?: number | null; - /** @description Authorization code on the charge. */ + /** + * @nullable + * @description Authorization code on the charge. + */ authorization_code?: string | null; - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `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. + * @format unix-time */ capture_before?: number; - /** @description Check results by Card networks on Card address and CVC at time of payment. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ exp_month: number; @@ -19834,61 +22998,104 @@ export interface components { exp_year: number; extended_authorization?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization"]; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; incremental_authorization?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization"]; /** + * @nullable * @description Installment details for this payment (Mexico only). * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ installments?: components["schemas"]["payment_method_details_card_installments"] | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description ID of the mandate used to make this payment or created by it. */ + /** + * @nullable + * @description ID of the mandate used to make this payment or created by it. + */ mandate?: string | null; multicapture?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_multicapture"]; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ network?: string | null; - /** @description If this card has network token credentials, this contains the details of the network token credentials. */ + /** + * @nullable + * @description If this card has network token credentials, this contains the details of the network token credentials. + */ network_token?: components["schemas"]["payment_method_details_card_network_token"] | null; - /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** + * @nullable + * @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. + */ network_transaction_id?: string | null; overcapture?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"]; /** + * @nullable * @description Status of a card based on the card issuer. * @enum {string|null} */ regulated_status?: "regulated" | "unregulated" | null; - /** @description Populated if this transaction used 3D Secure authentication. */ + /** + * @nullable + * @description Populated if this transaction used 3D Secure authentication. + */ three_d_secure?: components["schemas"]["three_d_secure_details_charge"] | null; - /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ + /** + * @nullable + * @description If this Card is part of a card wallet, this contains the details of the card wallet. + */ wallet?: components["schemas"]["payment_method_details_card_wallet"] | null; }; /** payment_method_details_card_checks */ payment_method_details_card_checks: { - /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. + */ cvc_check?: string | null; }; /** payment_method_details_card_installments */ payment_method_details_card_installments: { - /** @description Installment plan selected for the payment. */ + /** + * @nullable + * @description Installment plan selected for the payment. + */ plan?: components["schemas"]["payment_method_details_card_installments_plan"] | null; }; /** payment_method_details_card_installments_plan */ payment_method_details_card_installments_plan: { - /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ + /** + * @nullable + * @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. + */ count?: number | null; /** + * @nullable * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. * One of `month`. * @enum {string|null} @@ -19907,72 +23114,124 @@ export interface components { }; /** payment_method_details_card_present */ payment_method_details_card_present: { - /** @description The authorized amount */ + /** + * @nullable + * @description The authorized amount + */ amount_authorized?: number | null; - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ brand?: string | null; - /** @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ + /** + * @nullable + * @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. + */ brand_product?: string | null; /** - * Format: unix-time * @description When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. + * @format unix-time */ capture_before?: number; - /** @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /** + * @nullable + * @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. + */ cardholder_name?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; - /** @description A high-level description of the type of cards issued in this range. */ + /** + * @nullable + * @description A high-level description of the type of cards issued in this range. + */ description?: string | null; - /** @description Authorization response cryptogram. */ + /** + * @nullable + * @description Authorization response cryptogram. + */ emv_auth_data?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ + /** + * @nullable + * @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. + */ generated_card?: string | null; /** @description Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). */ incremental_authorization_supported: boolean; - /** @description The name of the card's issuing bank. */ + /** + * @nullable + * @description The name of the card's issuing bank. + */ issuer?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ network?: string | null; - /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** + * @nullable + * @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. + */ network_transaction_id?: string | null; - /** @description Details about payments collected offline. */ + /** + * @nullable + * @description Details about payments collected offline. + */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; /** @description Defines whether the authorized amount can be over-captured or not */ overcapture_supported: boolean; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. + */ preferred_locales?: string[] | null; /** + * @nullable * @description How card details were read in this transaction. * @enum {string|null} */ read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; - /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ + /** + * @nullable + * @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. + */ receipt?: components["schemas"]["payment_method_details_card_present_receipt"] | null; wallet?: components["schemas"]["payment_flows_private_payment_methods_card_present_common_wallet"]; }; /** payment_method_details_card_present_offline */ payment_method_details_card_present_offline: { /** - * Format: unix-time + * @nullable * @description Time at which the payment was collected while offline + * @format unix-time */ stored_at?: number | null; /** + * @nullable * @description The method used to process this payment method offline. Only deferred is allowed. * @enum {string|null} */ @@ -19985,28 +23244,55 @@ export interface components { * @enum {string} */ account_type?: "checking" | "credit" | "prepaid" | "unknown"; - /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. + */ application_cryptogram?: string | null; - /** @description Mnenomic of the Application Identifier. */ + /** + * @nullable + * @description Mnenomic of the Application Identifier. + */ application_preferred_name?: string | null; - /** @description Identifier for this transaction. */ + /** + * @nullable + * @description Identifier for this transaction. + */ authorization_code?: string | null; - /** @description EMV tag 8A. A code returned by the card issuer. */ + /** + * @nullable + * @description EMV tag 8A. A code returned by the card issuer. + */ authorization_response_code?: string | null; - /** @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ + /** + * @nullable + * @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. + */ cardholder_verification_method?: string | null; - /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. + */ dedicated_file_name?: string | null; - /** @description The outcome of a series of EMV functions performed by the card reader. */ + /** + * @nullable + * @description The outcome of a series of EMV functions performed by the card reader. + */ terminal_verification_results?: string | null; - /** @description An indication of various EMV functions performed during the transaction. */ + /** + * @nullable + * @description An indication of various EMV functions performed during the transaction. + */ transaction_status_information?: string | null; }; /** payment_method_details_card_wallet */ payment_method_details_card_wallet: { amex_express_checkout?: components["schemas"]["payment_method_details_card_wallet_amex_express_checkout"]; apple_pay?: components["schemas"]["payment_method_details_card_wallet_apple_pay"]; - /** @description (For tokenized numbers only.) The last four digits of the device account number. */ + /** + * @nullable + * @description (For tokenized numbers only.) The last four digits of the device account number. + */ dynamic_last4?: string | null; google_pay?: components["schemas"]["payment_method_details_card_wallet_google_pay"]; link?: components["schemas"]["payment_method_details_card_wallet_link"]; @@ -20029,33 +23315,63 @@ export interface components { payment_method_details_card_wallet_link: Record; /** payment_method_details_card_wallet_masterpass */ payment_method_details_card_wallet_masterpass: { - /** @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ billing_address?: components["schemas"]["address"] | null; - /** @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ email?: string | null; - /** @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ name?: string | null; - /** @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ shipping_address?: components["schemas"]["address"] | null; }; /** payment_method_details_card_wallet_samsung_pay */ payment_method_details_card_wallet_samsung_pay: Record; /** payment_method_details_card_wallet_visa_checkout */ payment_method_details_card_wallet_visa_checkout: { - /** @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ billing_address?: components["schemas"]["address"] | null; - /** @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ email?: string | null; - /** @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ name?: string | null; - /** @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ shipping_address?: components["schemas"]["address"] | null; }; /** payment_method_details_cashapp */ payment_method_details_cashapp: { - /** @description A unique and immutable identifier assigned by Cash App to every buyer. */ + /** + * @nullable + * @description A unique and immutable identifier assigned by Cash App to every buyer. + */ buyer_id?: string | null; - /** @description A public identifier for buyers using Cash App. */ + /** + * @nullable + * @description A public identifier for buyers using Cash App. + */ cashtag?: string | null; }; /** payment_method_details_customer_balance */ @@ -20063,11 +23379,13 @@ export interface components { /** payment_method_details_eps */ payment_method_details_eps: { /** + * @nullable * @description The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. * @enum {string|null} */ bank?: "arzte_und_apotheker_bank" | "austrian_anadi_bank_ag" | "bank_austria" | "bankhaus_carl_spangler" | "bankhaus_schelhammer_und_schattera_ag" | "bawag_psk_ag" | "bks_bank_ag" | "brull_kallmus_bank_ag" | "btv_vier_lander_bank" | "capital_bank_grawe_gruppe_ag" | "deutsche_bank_ag" | "dolomitenbank" | "easybank_ag" | "erste_bank_und_sparkassen" | "hypo_alpeadriabank_international_ag" | "hypo_bank_burgenland_aktiengesellschaft" | "hypo_noe_lb_fur_niederosterreich_u_wien" | "hypo_oberosterreich_salzburg_steiermark" | "hypo_tirol_bank_ag" | "hypo_vorarlberg_bank_ag" | "marchfelder_bank" | "oberbank_ag" | "raiffeisen_bankengruppe_osterreich" | "schoellerbank_ag" | "sparda_bank_wien" | "volksbank_gruppe" | "volkskreditbank_ag" | "vr_bank_braunau" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by EPS directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * EPS rarely provides this information so the attribute is usually empty. @@ -20081,18 +23399,31 @@ export interface components { * @enum {string} */ bank: "affin_bank" | "agrobank" | "alliance_bank" | "ambank" | "bank_islam" | "bank_muamalat" | "bank_of_china" | "bank_rakyat" | "bsn" | "cimb" | "deutsche_bank" | "hong_leong_bank" | "hsbc" | "kfh" | "maybank2e" | "maybank2u" | "ocbc" | "pb_enterprise" | "public_bank" | "rhb" | "standard_chartered" | "uob"; - /** @description Unique transaction id generated by FPX for every request from the merchant */ + /** + * @nullable + * @description Unique transaction id generated by FPX for every request from the merchant + */ transaction_id?: string | null; }; /** payment_method_details_giropay */ payment_method_details_giropay: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Giropay directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Giropay rarely provides this information so the attribute is usually empty. @@ -20101,28 +23432,43 @@ export interface components { }; /** payment_method_details_grabpay */ payment_method_details_grabpay: { - /** @description Unique transaction id generated by GrabPay */ + /** + * @nullable + * @description Unique transaction id generated by GrabPay + */ transaction_id?: string | null; }; /** payment_method_details_ideal */ payment_method_details_ideal: { /** + * @nullable * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; /** + * @nullable * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -20130,46 +23476,87 @@ export interface components { }; /** payment_method_details_interac_present */ payment_method_details_interac_present: { - /** @description Card brand. Can be `interac`, `mastercard` or `visa`. */ + /** + * @nullable + * @description Card brand. Can be `interac`, `mastercard` or `visa`. + */ brand?: string | null; - /** @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /** + * @nullable + * @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. + */ cardholder_name?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; - /** @description A high-level description of the type of cards issued in this range. */ + /** + * @nullable + * @description A high-level description of the type of cards issued in this range. + */ description?: string | null; - /** @description Authorization response cryptogram. */ + /** + * @nullable + * @description Authorization response cryptogram. + */ emv_auth_data?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ + /** + * @nullable + * @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. + */ generated_card?: string | null; - /** @description The name of the card's issuing bank. */ + /** + * @nullable + * @description The name of the card's issuing bank. + */ issuer?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ network?: string | null; - /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** + * @nullable + * @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. + */ network_transaction_id?: string | null; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. + */ preferred_locales?: string[] | null; /** + * @nullable * @description How card details were read in this transaction. * @enum {string|null} */ read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; - /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ + /** + * @nullable + * @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. + */ receipt?: components["schemas"]["payment_method_details_interac_present_receipt"] | null; }; /** payment_method_details_interac_present_receipt */ @@ -20179,38 +23566,70 @@ export interface components { * @enum {string} */ account_type?: "checking" | "savings" | "unknown"; - /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. + */ application_cryptogram?: string | null; - /** @description Mnenomic of the Application Identifier. */ + /** + * @nullable + * @description Mnenomic of the Application Identifier. + */ application_preferred_name?: string | null; - /** @description Identifier for this transaction. */ + /** + * @nullable + * @description Identifier for this transaction. + */ authorization_code?: string | null; - /** @description EMV tag 8A. A code returned by the card issuer. */ + /** + * @nullable + * @description EMV tag 8A. A code returned by the card issuer. + */ authorization_response_code?: string | null; - /** @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ + /** + * @nullable + * @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. + */ cardholder_verification_method?: string | null; - /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. + */ dedicated_file_name?: string | null; - /** @description The outcome of a series of EMV functions performed by the card reader. */ + /** + * @nullable + * @description The outcome of a series of EMV functions performed by the card reader. + */ terminal_verification_results?: string | null; - /** @description An indication of various EMV functions performed during the transaction. */ + /** + * @nullable + * @description An indication of various EMV functions performed during the transaction. + */ transaction_status_information?: string | null; }; /** payment_method_details_kakao_pay */ payment_method_details_kakao_pay: { - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; }; /** payment_method_details_klarna */ payment_method_details_klarna: { - /** @description The payer details for this transaction. */ + /** + * @nullable + * @description The payer details for this transaction. + */ payer_details?: components["schemas"]["klarna_payer_details"] | null; /** + * @nullable * @description The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` */ payment_method_category?: string | null; /** + * @nullable * @description Preferred language of the Klarna authorization page that the customer is redirected to. * Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH` */ @@ -20218,12 +23637,16 @@ export interface components { }; /** payment_method_details_konbini */ payment_method_details_konbini: { - /** @description If the payment succeeded, this contains the details of the convenience store where the payment was completed. */ + /** + * @nullable + * @description If the payment succeeded, this contains the details of the convenience store where the payment was completed. + */ store?: components["schemas"]["payment_method_details_konbini_store"] | null; }; /** payment_method_details_konbini_store */ payment_method_details_konbini_store: { /** + * @nullable * @description The name of the convenience store chain where the payment was completed. * @enum {string|null} */ @@ -20232,18 +23655,26 @@ export interface components { /** payment_method_details_kr_card */ payment_method_details_kr_card: { /** + * @nullable * @description The local credit or debit card brand. * @enum {string|null} */ brand?: "bc" | "citi" | "hana" | "hyundai" | "jeju" | "jeonbuk" | "kakaobank" | "kbank" | "kdbbank" | "kookmin" | "kwangju" | "lotte" | "mg" | "nh" | "post" | "samsung" | "savingsbank" | "shinhan" | "shinhyup" | "suhyup" | "tossbank" | "woori" | null; - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; - /** @description The last four digits of the card. This may not be present for American Express cards. */ + /** + * @nullable + * @description The last four digits of the card. This may not be present for American Express cards. + */ last4?: string | null; }; /** payment_method_details_link */ payment_method_details_link: { /** + * @nullable * @description Two-letter ISO code representing the funding source country beneath the Link payment. * You could use this attribute to get a sense of international fees. */ @@ -20251,36 +23682,56 @@ export interface components { }; /** payment_method_details_mobilepay */ payment_method_details_mobilepay: { - /** @description Internal card details */ + /** + * @nullable + * @description Internal card details + */ card?: components["schemas"]["internal_card"] | null; }; /** payment_method_details_multibanco */ payment_method_details_multibanco: { - /** @description Entity number associated with this Multibanco payment. */ + /** + * @nullable + * @description Entity number associated with this Multibanco payment. + */ entity?: string | null; - /** @description Reference number associated with this Multibanco payment. */ + /** + * @nullable + * @description Reference number associated with this Multibanco payment. + */ reference?: string | null; }; /** payment_method_details_naver_pay */ payment_method_details_naver_pay: { - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; }; /** payment_method_details_oxxo */ payment_method_details_oxxo: { - /** @description OXXO reference number */ + /** + * @nullable + * @description OXXO reference number + */ number?: string | null; }; /** payment_method_details_p24 */ payment_method_details_p24: { /** + * @nullable * @description The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. * @enum {string|null} */ bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank" | null; - /** @description Unique reference for this Przelewy24 payment. */ + /** + * @nullable + * @description Unique reference for this Przelewy24 payment. + */ reference?: string | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Przelewy24 directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Przelewy24 rarely provides this information so the attribute is usually empty. @@ -20289,60 +23740,104 @@ export interface components { }; /** payment_method_details_passthrough_card */ payment_method_details_passthrough_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ brand?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @description Two-digit number representing the card's expiration month. + */ exp_month?: number | null; - /** @description Four-digit number representing the card's expiration year. */ + /** + * @nullable + * @description Four-digit number representing the card's expiration year. + */ exp_year?: number | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; }; /** payment_method_details_pay_by_bank */ payment_method_details_pay_by_bank: Record; /** payment_method_details_payco */ payment_method_details_payco: { - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; }; /** payment_method_details_paynow */ payment_method_details_paynow: { - /** @description Reference number associated with this PayNow payment */ + /** + * @nullable + * @description Reference number associated with this PayNow payment + */ reference?: string | null; }; /** payment_method_details_paypal */ payment_method_details_paypal: { - /** @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ country?: string | null; /** + * @nullable * @description Owner's email. Values are provided by PayPal directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ payer_email?: string | null; - /** @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ + /** + * @nullable + * @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. + */ payer_id?: string | null; /** + * @nullable * @description Owner's full name. Values provided by PayPal directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ payer_name?: string | null; - /** @description The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction. */ + /** + * @nullable + * @description The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction. + */ seller_protection?: components["schemas"]["paypal_seller_protection"] | null; - /** @description A unique ID generated by PayPal for this transaction. */ + /** + * @nullable + * @description A unique ID generated by PayPal for this transaction. + */ transaction_id?: string | null; }; /** payment_method_details_pix */ payment_method_details_pix: { - /** @description Unique transaction id generated by BCB */ + /** + * @nullable + * @description Unique transaction id generated by BCB + */ bank_transaction_id?: string | null; }; /** payment_method_details_promptpay */ payment_method_details_promptpay: { - /** @description Bill reference generated by PromptPay */ + /** + * @nullable + * @description Bill reference generated by PromptPay + */ reference?: string | null; }; /** payment_method_details_revolut_pay */ @@ -20351,47 +23846,91 @@ export interface components { }; /** payment_method_details_samsung_pay */ payment_method_details_samsung_pay: { - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; }; /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Branch code of bank associated with the bank account. */ + /** + * @nullable + * @description Branch code of bank associated with the bank account. + */ branch_code?: string | null; - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ last4?: string | null; - /** @description Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve). */ + /** + * @nullable + * @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 */ payment_method_details_sofort: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` * @enum {string|null} */ preferred_language?: "de" | "en" | "es" | "fr" | "it" | "nl" | "pl" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by SOFORT directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -20401,11 +23940,20 @@ export interface components { payment_method_details_stripe_account: Record; /** payment_method_details_swish */ payment_method_details_swish: { - /** @description Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer */ + /** + * @nullable + * @description Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer + */ fingerprint?: string | null; - /** @description Payer bank reference number for the payment */ + /** + * @nullable + * @description Payer bank reference number for the payment + */ payment_reference?: string | null; - /** @description The last four digits of the Swish account phone number */ + /** + * @nullable + * @description The last four digits of the Swish account phone number + */ verified_phone_last4?: string | null; }; /** payment_method_details_twint */ @@ -20413,35 +23961,58 @@ export interface components { /** payment_method_details_us_bank_account */ payment_method_details_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; - /** @description Reference number to locate ACH payments with customer's bank. */ + /** + * @nullable + * @description Reference number to locate ACH payments with customer's bank. + */ payment_reference?: string | null; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; }; /** payment_method_details_wechat */ payment_method_details_wechat: Record; /** payment_method_details_wechat_pay */ payment_method_details_wechat_pay: { - /** @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. + */ fingerprint?: string | null; - /** @description Transaction ID of this particular WeChat Pay transaction. */ + /** + * @nullable + * @description Transaction ID of this particular WeChat Pay transaction. + */ transaction_id?: string | null; }; /** payment_method_details_zip */ @@ -20457,8 +24028,8 @@ export interface components { amazon_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"]; apple_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The domain name that this payment method domain object represents. */ @@ -20501,6 +24072,7 @@ export interface components { /** payment_method_eps */ payment_method_eps: { /** + * @nullable * @description The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. * @enum {string|null} */ @@ -20521,11 +24093,13 @@ export interface components { /** payment_method_ideal */ payment_method_ideal: { /** + * @nullable * @description The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; /** + * @nullable * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string|null} */ @@ -20533,35 +24107,64 @@ export interface components { }; /** payment_method_interac_present */ payment_method_interac_present: { - /** @description Card brand. Can be `interac`, `mastercard` or `visa`. */ + /** + * @nullable + * @description Card brand. Can be `interac`, `mastercard` or `visa`. + */ brand?: string | null; - /** @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /** + * @nullable + * @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. + */ cardholder_name?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; - /** @description A high-level description of the type of cards issued in this range. */ + /** + * @nullable + * @description A high-level description of the type of cards issued in this range. + */ description?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description The name of the card's issuing bank. */ + /** + * @nullable + * @description The name of the card's issuing bank. + */ issuer?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Contains information about card networks that can be used to process the payment. */ + /** + * @nullable + * @description Contains information about card networks that can be used to process the payment. + */ networks?: components["schemas"]["payment_method_card_present_networks"] | null; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. + */ preferred_locales?: string[] | null; /** + * @nullable * @description How card details were read in this transaction. * @enum {string|null} */ @@ -20571,7 +24174,10 @@ export interface components { payment_method_kakao_pay: Record; /** payment_method_klarna */ payment_method_klarna: { - /** @description The customer's date of birth, if provided. */ + /** + * @nullable + * @description The customer's date of birth, if provided. + */ dob?: components["schemas"]["payment_flows_private_payment_methods_klarna_dob"] | null; }; /** payment_method_konbini */ @@ -20579,16 +24185,23 @@ export interface components { /** payment_method_kr_card */ payment_method_kr_card: { /** + * @nullable * @description The local credit or debit card brand. * @enum {string|null} */ brand?: "bc" | "citi" | "hana" | "hyundai" | "jeju" | "jeonbuk" | "kakaobank" | "kbank" | "kdbbank" | "kookmin" | "kwangju" | "lotte" | "mg" | "nh" | "post" | "samsung" | "savingsbank" | "shinhan" | "shinhyup" | "suhyup" | "tossbank" | "woori" | null; - /** @description The last four digits of the card. This may not be present for American Express cards. */ + /** + * @nullable + * @description The last four digits of the card. This may not be present for American Express cards. + */ last4?: string | null; }; /** payment_method_link */ payment_method_link: { - /** @description Account owner's email address. */ + /** + * @nullable + * @description Account owner's email address. + */ email?: string | null; }; /** payment_method_mobilepay */ @@ -20632,6 +24245,7 @@ export interface components { */ capture_method?: "manual"; /** + * @nullable * @description An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. * This field differs from the statement descriptor and item name. */ @@ -20726,11 +24340,17 @@ export interface components { }; /** payment_method_options_card_installments */ payment_method_options_card_installments: { - /** @description Installment plans that may be selected for this PaymentIntent. */ + /** + * @nullable + * @description Installment plans that may be selected for this PaymentIntent. + */ available_plans?: components["schemas"]["payment_method_details_card_installments_plan"][] | null; /** @description Whether Installments are enabled for this PaymentIntent. */ enabled: boolean; - /** @description Installment plan selected for this PaymentIntent. */ + /** + * @nullable + * @description Installment plan selected for this PaymentIntent. + */ plan?: components["schemas"]["payment_method_details_card_installments_plan"] | null; }; /** payment_method_options_card_mandate_options */ @@ -20742,11 +24362,15 @@ export interface components { * @enum {string} */ amount_type: "fixed" | "maximum"; - /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ + /** + * @nullable + * @description A description of the mandate or subscription that is meant to be displayed to the customer. + */ description?: string | null; /** - * Format: unix-time + * @nullable * @description End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. + * @format unix-time */ end_date?: number | null; /** @@ -20754,29 +24378,42 @@ export interface components { * @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; - /** @description The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. */ + /** + * @nullable + * @description The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. + */ interval_count?: number | null; /** @description Unique identifier for the mandate or subscription. */ reference: string; /** - * Format: unix-time * @description Start date of the mandate or subscription. Start date should not be lesser than yesterday. + * @format unix-time */ start_date: number; - /** @description Specifies the type of mandates supported. Possible values are `india`. */ + /** + * @nullable + * @description Specifies the type of mandates supported. Possible values are `india`. + */ supported_types?: "india"[] | null; }; /** payment_method_options_card_present */ payment_method_options_card_present: { - /** @description Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) */ + /** + * @nullable + * @description Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) + */ request_extended_authorization?: boolean | null; - /** @description Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. */ + /** + * @nullable + * @description Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. + */ request_incremental_authorization_support?: boolean | null; routing?: components["schemas"]["payment_method_options_card_present_routing"]; }; /** payment_method_options_card_present_routing */ payment_method_options_card_present_routing: { /** + * @nullable * @description Requested routing priority * @enum {string|null} */ @@ -20805,6 +24442,7 @@ export interface components { payment_method_options_customer_balance: { bank_transfer?: components["schemas"]["payment_method_options_customer_balance_bank_transfer"]; /** + * @nullable * @description The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. * @enum {string|null} */ @@ -20831,6 +24469,7 @@ export interface components { */ requested_address_types?: ("aba" | "iban" | "sepa" | "sort_code" | "spei" | "swift" | "zengin")[]; /** + * @nullable * @description The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. * @enum {string|null} */ @@ -20909,7 +24548,10 @@ export interface components { * @enum {string} */ capture_method?: "manual"; - /** @description Preferred locale of the Klarna checkout page that the customer is redirected to. */ + /** + * @nullable + * @description Preferred locale of the Klarna checkout page that the customer is redirected to. + */ preferred_locale?: string | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -20925,16 +24567,26 @@ export interface components { }; /** payment_method_options_konbini */ payment_method_options_konbini: { - /** @description An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. */ + /** + * @nullable + * @description An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. + */ confirmation_number?: string | null; - /** @description The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. */ + /** + * @nullable + * @description The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. + */ expires_after_days?: number | null; /** - * Format: unix-time + * @nullable * @description The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set. + * @format unix-time */ expires_at?: number | null; - /** @description A product descriptor of up to 22 characters, which will appear to customers at the convenience store. */ + /** + * @nullable + * @description A product descriptor of up to 22 characters, which will appear to customers at the convenience store. + */ product_description?: string | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -21034,9 +24686,15 @@ export interface components { * @enum {string} */ capture_method?: "manual"; - /** @description Preferred locale of the PayPal checkout page that the customer is redirected to. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. @@ -21052,9 +24710,15 @@ export interface components { }; /** payment_method_options_pix */ payment_method_options_pix: { - /** @description The number of seconds (between 10 and 1209600) after which Pix payment will expire. */ + /** + * @nullable + * @description The number of seconds (between 10 and 1209600) after which Pix payment will expire. + */ expires_after_seconds?: number | null; - /** @description The timestamp at which the Pix expires. */ + /** + * @nullable + * @description The timestamp at which the Pix expires. + */ expires_at?: number | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -21104,6 +24768,7 @@ export interface components { /** payment_method_options_sofort */ payment_method_options_sofort: { /** + * @nullable * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * @enum {string|null} */ @@ -21144,9 +24809,13 @@ export interface components { }; /** payment_method_options_wechat_pay */ payment_method_options_wechat_pay: { - /** @description The app ID registered with WeChat Pay. Only required when client is ios or android. */ + /** + * @nullable + * @description The app ID registered with WeChat Pay. Only required when client is ios or android. + */ app_id?: string | null; /** + * @nullable * @description The client type that the end customer will pay from * @enum {string|null} */ @@ -21182,6 +24851,7 @@ export interface components { /** payment_method_p24 */ payment_method_p24: { /** + * @nullable * @description The customer's bank, if provided. * @enum {string|null} */ @@ -21195,14 +24865,21 @@ export interface components { payment_method_paynow: Record; /** payment_method_paypal */ payment_method_paypal: { - /** @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ country?: string | null; /** + * @nullable * @description Owner's email. Values are provided by PayPal directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ payer_email?: string | null; - /** @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ + /** + * @nullable + * @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. + */ payer_id?: string | null; }; /** payment_method_pix */ @@ -21215,22 +24892,43 @@ export interface components { payment_method_samsung_pay: Record; /** payment_method_sepa_debit */ payment_method_sepa_debit: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Branch code of bank associated with the bank account. */ + /** + * @nullable + * @description Branch code of bank associated with the bank account. + */ branch_code?: string | null; - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Information about the object that generated this PaymentMethod. */ + /** + * @nullable + * @description Information about the object that generated this PaymentMethod. + */ generated_from?: components["schemas"]["sepa_debit_generated_from"] | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ last4?: string | null; }; /** payment_method_sofort */ payment_method_sofort: { - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; }; /** payment_method_swish */ @@ -21240,38 +24938,63 @@ export interface components { /** payment_method_us_bank_account */ payment_method_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description The name of the bank. */ + /** + * @nullable + * @description The name of the bank. + */ bank_name?: string | null; - /** @description The ID of the Financial Connections Account used to create the payment method. */ + /** + * @nullable + * @description The ID of the Financial Connections Account used to create the payment method. + */ financial_connections_account?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description Contains information about US bank account networks that can be used. */ + /** + * @nullable + * @description Contains information about US bank account networks that can be used. + */ networks?: components["schemas"]["us_bank_account_networks"] | null; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; - /** @description Contains information about the future reusability of this PaymentMethod. */ + /** + * @nullable + * @description Contains information about the future reusability of this PaymentMethod. + */ status_details?: components["schemas"]["payment_method_us_bank_account_status_details"] | null; }; /** payment_method_us_bank_account_blocked */ payment_method_us_bank_account_blocked: { /** + * @nullable * @description The ACH network code that resulted in this block. * @enum {string|null} */ network_code?: "R02" | "R03" | "R04" | "R05" | "R07" | "R08" | "R10" | "R11" | "R16" | "R20" | "R29" | "R31" | null; /** + * @nullable * @description The reason why this PaymentMethod's fingerprint has been blocked * @enum {string|null} */ @@ -21292,7 +25015,10 @@ export interface components { }; /** PaymentPagesCheckoutSessionAfterExpiration */ payment_pages_checkout_session_after_expiration: { - /** @description When set, configuration used to recover the Checkout Session on expiry. */ + /** + * @nullable + * @description When set, configuration used to recover the Checkout Session on expiry. + */ recovery?: components["schemas"]["payment_pages_checkout_session_after_expiration_recovery"] | null; }; /** PaymentPagesCheckoutSessionAfterExpirationRecovery */ @@ -21306,20 +25032,28 @@ export interface components { */ enabled: boolean; /** - * Format: unix-time + * @nullable * @description The timestamp at which the recovery URL will expire. + * @format unix-time */ expires_at?: number | null; - /** @description URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session */ + /** + * @nullable + * @description URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session + */ url?: string | null; }; /** PaymentPagesCheckoutSessionAutomaticTax */ payment_pages_checkout_session_automatic_tax: { /** @description Indicates whether automatic tax is enabled for the session */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; /** + * @nullable * @description The status of the most recent automated tax calculation for this session. * @enum {string|null} */ @@ -21328,12 +25062,14 @@ export interface components { /** PaymentPagesCheckoutSessionConsent */ payment_pages_checkout_session_consent: { /** + * @nullable * @description If `opt_in`, the customer consents to receiving promotional communications * from the merchant about this Checkout Session. * @enum {string|null} */ promotions?: "opt_in" | "opt_out" | null; /** + * @nullable * @description If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service. * @enum {string|null} */ @@ -21341,9 +25077,13 @@ export interface components { }; /** PaymentPagesCheckoutSessionConsentCollection */ payment_pages_checkout_session_consent_collection: { - /** @description If set to `hidden`, it will hide legal text related to the reuse of a payment method. */ + /** + * @nullable + * @description If set to `hidden`, it will hide legal text related to the reuse of a payment method. + */ payment_method_reuse_agreement?: components["schemas"]["payment_pages_checkout_session_payment_method_reuse_agreement"] | null; /** + * @nullable * @description If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout * Session will determine whether to display an option to opt into promotional communication * from the merchant depending on the customer's locale. Only available to US merchants. @@ -21351,6 +25091,7 @@ export interface components { */ promotions?: "auto" | "none" | null; /** + * @nullable * @description If set to `required`, it requires customers to accept the terms of service before being able to pay. * @enum {string|null} */ @@ -21363,8 +25104,8 @@ export interface components { /** @description Total of all items in source currency after discounts and taxes are applied. */ amount_total: number; /** - * Format: decimal * @description Exchange rate used to convert source currency amounts to customer currency amounts + * @format decimal */ fx_rate: string; /** @description Creation currency of the CheckoutSession before localization */ @@ -21388,16 +25129,25 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFieldsDropdown */ payment_pages_checkout_session_custom_fields_dropdown: { - /** @description The value that will pre-fill on the payment page. */ + /** + * @nullable + * @description The value that will pre-fill on the payment page. + */ default_value?: string | null; /** @description The options available for the customer to select. Up to 200 options allowed. */ options: components["schemas"]["payment_pages_checkout_session_custom_fields_option"][]; - /** @description The option selected by the customer. This will be the `value` for the option. */ + /** + * @nullable + * @description The option selected by the customer. This will be the `value` for the option. + */ value?: string | null; }; /** PaymentPagesCheckoutSessionCustomFieldsLabel */ payment_pages_checkout_session_custom_fields_label: { - /** @description Custom text for the label, displayed to the customer. Up to 50 characters. */ + /** + * @nullable + * @description Custom text for the label, displayed to the customer. Up to 50 characters. + */ custom?: string | null; /** * @description The type of the label. @@ -21407,13 +25157,25 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFieldsNumeric */ payment_pages_checkout_session_custom_fields_numeric: { - /** @description The value that will pre-fill the field on the payment page. */ + /** + * @nullable + * @description The value that will pre-fill the field on the payment page. + */ default_value?: string | null; - /** @description The maximum character length constraint for the customer's input. */ + /** + * @nullable + * @description The maximum character length constraint for the customer's input. + */ maximum_length?: number | null; - /** @description The minimum character length requirement for the customer's input. */ + /** + * @nullable + * @description The minimum character length requirement for the customer's input. + */ minimum_length?: number | null; - /** @description The value entered by the customer, containing only digits. */ + /** + * @nullable + * @description The value entered by the customer, containing only digits. + */ value?: string | null; }; /** PaymentPagesCheckoutSessionCustomFieldsOption */ @@ -21425,24 +25187,48 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFieldsText */ payment_pages_checkout_session_custom_fields_text: { - /** @description The value that will pre-fill the field on the payment page. */ + /** + * @nullable + * @description The value that will pre-fill the field on the payment page. + */ default_value?: string | null; - /** @description The maximum character length constraint for the customer's input. */ + /** + * @nullable + * @description The maximum character length constraint for the customer's input. + */ maximum_length?: number | null; - /** @description The minimum character length requirement for the customer's input. */ + /** + * @nullable + * @description The minimum character length requirement for the customer's input. + */ minimum_length?: number | null; - /** @description The value entered by the customer. */ + /** + * @nullable + * @description The value entered by the customer. + */ value?: string | null; }; /** PaymentPagesCheckoutSessionCustomText */ payment_pages_checkout_session_custom_text: { - /** @description Custom text that should be displayed after the payment confirmation button. */ + /** + * @nullable + * @description Custom text that should be displayed after the payment confirmation button. + */ after_submit?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; - /** @description Custom text that should be displayed alongside shipping address collection. */ + /** + * @nullable + * @description Custom text that should be displayed alongside shipping address collection. + */ shipping_address?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; - /** @description Custom text that should be displayed alongside the payment confirmation button. */ + /** + * @nullable + * @description Custom text that should be displayed alongside the payment confirmation button. + */ submit?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; - /** @description Custom text that should be displayed in place of the default terms of service agreement text. */ + /** + * @nullable + * @description Custom text that should be displayed in place of the default terms of service agreement text. + */ terms_of_service_acceptance?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; }; /** PaymentPagesCheckoutSessionCustomTextPosition */ @@ -21452,30 +25238,50 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomerDetails */ payment_pages_checkout_session_customer_details: { - /** @description The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. */ + /** + * @nullable + * @description The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. + */ address?: components["schemas"]["address"] | null; /** + * @nullable * @description The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry. * Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form. */ email?: string | null; - /** @description The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. */ + /** + * @nullable + * @description The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. + */ name?: string | null; - /** @description The customer's phone number after a completed Checkout Session. */ + /** + * @nullable + * @description The customer's phone number after a completed Checkout Session. + */ phone?: string | null; /** + * @nullable * @description The customer’s tax exempt status after a completed Checkout Session. * @enum {string|null} */ tax_exempt?: "exempt" | "none" | "reverse" | null; - /** @description The customer’s tax IDs after a completed Checkout Session. */ + /** + * @nullable + * @description The customer’s tax IDs after a completed Checkout Session. + */ tax_ids?: components["schemas"]["payment_pages_checkout_session_tax_id"][] | null; }; /** PaymentPagesCheckoutSessionDiscount */ payment_pages_checkout_session_discount: { - /** @description Coupon attached to the Checkout Session. */ + /** + * @nullable + * @description Coupon attached to the Checkout Session. + */ coupon?: (string | components["schemas"]["coupon"]) | null; - /** @description Promotion code attached to the Checkout Session. */ + /** + * @nullable + * @description Promotion code attached to the Checkout Session. + */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; }; /** PaymentPagesCheckoutSessionInvoiceCreation */ @@ -21486,21 +25292,42 @@ export interface components { }; /** PaymentPagesCheckoutSessionInvoiceSettings */ payment_pages_checkout_session_invoice_settings: { - /** @description The account tax IDs associated with the invoice. */ + /** + * @nullable + * @description The account tax IDs associated with the invoice. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; - /** @description Custom fields displayed on the invoice. */ + /** + * @nullable + * @description Custom fields displayed on the invoice. + */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Footer displayed on the invoice. */ + /** + * @nullable + * @description Footer displayed on the invoice. + */ footer?: string | null; - /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + /** + * @nullable + * @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. + */ issuer?: components["schemas"]["connect_account_reference"] | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description Options for invoice PDF rendering. */ + /** + * @nullable + * @description Options for invoice PDF rendering. + */ rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; }; /** PaymentPagesCheckoutSessionPaymentMethodReuseAgreement */ @@ -21520,14 +25347,19 @@ export interface components { }; /** PaymentPagesCheckoutSessionSavedPaymentMethodOptions */ payment_pages_checkout_session_saved_payment_method_options: { - /** @description Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. */ + /** + * @nullable + * @description Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. + */ allow_redisplay_filters?: ("always" | "limited" | "unspecified")[] | null; /** + * @nullable * @description Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. * @enum {string|null} */ payment_method_remove?: "disabled" | "enabled" | null; /** + * @nullable * @description Enable customers to choose if they wish to save their payment method for future use. Disabled by default. * @enum {string|null} */ @@ -21549,7 +25381,10 @@ export interface components { amount_tax: number; /** @description Total shipping cost after discounts and taxes are applied. */ amount_total: number; - /** @description The ID of the ShippingRate for this order. */ + /** + * @nullable + * @description The ID of the ShippingRate for this order. + */ shipping_rate?: (string | components["schemas"]["shipping_rate"]) | null; /** @description The taxes applied to the shipping rate. */ taxes?: components["schemas"]["line_items_tax_amount"][]; @@ -21568,7 +25403,10 @@ export interface components { * @enum {string} */ type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; - /** @description The value of the tax ID. */ + /** + * @nullable + * @description The value of the tax ID. + */ value?: string | null; }; /** PaymentPagesCheckoutSessionTaxIDCollection */ @@ -21585,7 +25423,10 @@ export interface components { payment_pages_checkout_session_total_details: { /** @description This is the sum of all the discounts. */ amount_discount: number; - /** @description This is the sum of all the shipping amounts. */ + /** + * @nullable + * @description This is the sum of all the shipping amounts. + */ amount_shipping?: number | null; /** @description This is the sum of all the tax amounts. */ amount_tax: number; @@ -21614,44 +25455,71 @@ export interface components { payout: { /** @description The amount (in cents (or local equivalent)) that transfers to your bank account or debit card. */ amount: number; - /** @description The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. */ + /** + * @nullable + * @description The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. + */ application_fee?: (string | components["schemas"]["application_fee"]) | null; - /** @description The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. */ + /** + * @nullable + * @description The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. + */ application_fee_amount?: number | null; /** - * Format: unix-time * @description Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. + * @format unix-time */ arrival_date: number; /** @description Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ automatic: boolean; - /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ + /** + * @nullable + * @description ID of the balance transaction that describes the impact of this payout on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description ID of the bank account or card the payout is sent to. */ + /** + * @nullable + * @description ID of the bank account or card the payout is sent to. + */ destination?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["deleted_bank_account"] | components["schemas"]["deleted_card"]) | null; - /** @description If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. */ + /** + * @nullable + * @description If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. + */ failure_balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; - /** @description Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). */ + /** + * @nullable + * @description Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). + */ failure_code?: string | null; - /** @description Message that provides the reason for a payout failure, if available. */ + /** + * @nullable + * @description Message that provides the reason for a payout failure, if available. + */ failure_message?: string | null; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -21662,22 +25530,34 @@ export interface components { * @enum {string} */ object: "payout"; - /** @description If the payout reverses another, this is the ID of the original payout. */ + /** + * @nullable + * @description If the payout reverses another, this is the ID of the original payout. + */ original_payout?: (string | components["schemas"]["payout"]) | null; /** * @description If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. * @enum {string} */ reconciliation_status: "completed" | "in_progress" | "not_applicable"; - /** @description If the payout reverses, this is the ID of the payout that reverses this payout. */ + /** + * @nullable + * @description If the payout reverses, this is the ID of the payout that reverses this payout. + */ reversed_by?: (string | components["schemas"]["payout"]) | null; /** @description The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`. */ source_type: string; - /** @description Extra information about a payout that displays on the user's bank statement. */ + /** + * @nullable + * @description Extra information about a payout that displays on the user's bank statement. + */ statement_descriptor?: string | null; /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. */ status: string; - /** @description A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar. */ + /** + * @nullable + * @description A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar. + */ trace_id?: components["schemas"]["payouts_trace_id"] | null; /** * @description Can be `bank_account` or `card`. @@ -21689,12 +25569,18 @@ export interface components { payouts_trace_id: { /** @description Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`. */ status: string; - /** @description The trace ID value if `trace_id.status` is `supported`, otherwise `nil`. */ + /** + * @nullable + * @description The trace ID value if `trace_id.status` is `supported`, otherwise `nil`. + */ value?: string | null; }; /** paypal_seller_protection */ paypal_seller_protection: { - /** @description An array of conditions that are covered for the transaction, if applicable. */ + /** + * @nullable + * @description An array of conditions that are covered for the transaction, if applicable. + */ dispute_categories?: ("fraudulent" | "product_not_received")[] | null; /** * @description Indicates whether the transaction is eligible for PayPal's seller protection. @@ -21705,13 +25591,15 @@ export interface components { /** Period */ period: { /** - * Format: unix-time + * @nullable * @description The end date of this usage period. All usage up to and including this point in time is included. + * @format unix-time */ end?: number | null; /** - * Format: unix-time + * @nullable * @description The start date of this usage period. All usage after this point in time is included. + * @format unix-time */ start?: number | null; }; @@ -21728,26 +25616,44 @@ export interface components { account: string; additional_tos_acceptances?: components["schemas"]["person_additional_tos_acceptances"]; address?: components["schemas"]["address"]; + /** @nullable */ address_kana?: components["schemas"]["legal_entity_japan_address"] | null; + /** @nullable */ address_kanji?: components["schemas"]["legal_entity_japan_address"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; dob?: components["schemas"]["legal_entity_dob"]; - /** @description The person's email address. */ + /** + * @nullable + * @description The person's email address. + */ email?: string | null; - /** @description The person's first name. */ + /** + * @nullable + * @description The person's first name. + */ first_name?: string | null; - /** @description The Kana variation of the person's first name (Japan only). */ + /** + * @nullable + * @description The Kana variation of the person's first name (Japan only). + */ first_name_kana?: string | null; - /** @description The Kanji variation of the person's first name (Japan only). */ + /** + * @nullable + * @description The Kanji variation of the person's first name (Japan only). + */ first_name_kanji?: string | null; /** @description A list of alternate names or aliases that the person is known by. */ full_name_aliases?: string[]; + /** @nullable */ future_requirements?: components["schemas"]["person_future_requirements"] | null; - /** @description The person's gender. */ + /** + * @nullable + * @description The person's gender. + */ gender?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -21755,26 +25661,44 @@ export interface components { id_number_provided?: boolean; /** @description Whether the person's `id_number_secondary` was provided. */ id_number_secondary_provided?: boolean; - /** @description The person's last name. */ + /** + * @nullable + * @description The person's last name. + */ last_name?: string | null; - /** @description The Kana variation of the person's last name (Japan only). */ + /** + * @nullable + * @description The Kana variation of the person's last name (Japan only). + */ last_name_kana?: string | null; - /** @description The Kanji variation of the person's last name (Japan only). */ + /** + * @nullable + * @description The Kanji variation of the person's last name (Japan only). + */ last_name_kanji?: string | null; - /** @description The person's maiden name. */ + /** + * @nullable + * @description The person's maiden name. + */ maiden_name?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { [key: string]: string; }; - /** @description The country where the person is a national. */ + /** + * @nullable + * @description The country where the person is a national. + */ nationality?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "person"; - /** @description The person's phone number. */ + /** + * @nullable + * @description The person's phone number. + */ phone?: string | null; /** * @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. @@ -21783,6 +25707,7 @@ export interface components { political_exposure?: "existing" | "none"; registered_address?: components["schemas"]["address"]; relationship?: components["schemas"]["person_relationship"]; + /** @nullable */ requirements?: components["schemas"]["person_requirements"] | null; /** @description Whether the last four digits of the person's Social Security number have been provided (U.S. only). */ ssn_last_4_provided?: boolean; @@ -21791,23 +25716,36 @@ export interface components { /** PersonAdditionalTOSAcceptance */ person_additional_tos_acceptance: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the legal guardian accepted the service agreement. + * @format unix-time */ date?: number | null; - /** @description The IP address from which the legal guardian accepted the service agreement. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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: { - /** @description Details on the legal guardian's acceptance of the main Stripe service agreement. */ + /** + * @nullable + * @description Details on the legal guardian's acceptance of the main Stripe service agreement. + */ account?: components["schemas"]["person_additional_tos_acceptance"] | null; }; /** PersonFutureRequirements */ person_future_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** @description Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition. */ currently_due: string[]; @@ -21822,26 +25760,53 @@ export interface components { }; /** PersonRelationship */ person_relationship: { - /** @description Whether the person is the authorizer of the account's representative. */ + /** + * @nullable + * @description Whether the person is the authorizer of the account's representative. + */ authorizer?: boolean | null; - /** @description Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. */ + /** + * @nullable + * @description Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. + */ director?: boolean | null; - /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @description The percent owned by the person of the account's legal entity. + */ percent_ownership?: number | null; - /** @description Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. */ + /** + * @nullable + * @description Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. + */ representative?: boolean | null; - /** @description The person's title (e.g., CEO, Support Engineer). */ + /** + * @nullable + * @description The person's title (e.g., CEO, Support Engineer). + */ title?: string | null; }; /** PersonRequirements */ person_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** @description Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ currently_due: string[]; @@ -21869,15 +25834,20 @@ export interface components { /** @description Whether the plan can be used for new purchases. */ active: boolean; /** + * @nullable * @description Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. * @enum {string|null} */ aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum" | null; - /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /** + * @nullable + * @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + */ amount?: number | null; /** - * Format: decimal + * @nullable * @description The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * @format decimal */ amount_decimal?: string | null; /** @@ -21886,13 +25856,13 @@ export interface components { */ billing_scheme: "per_unit" | "tiered"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Unique identifier for the object. */ @@ -21906,31 +25876,50 @@ export interface components { interval_count: number; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description The meter tracking the usage of a metered price */ + /** + * @nullable + * @description The meter tracking the usage of a metered price + */ meter?: string | null; - /** @description A brief description of the plan, hidden from customers. */ + /** + * @nullable + * @description A brief description of the plan, hidden from customers. + */ nickname?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "plan"; - /** @description The product whose pricing this plan determines. */ + /** + * @nullable + * @description The product whose pricing this plan determines. + */ product?: (string | components["schemas"]["product"] | components["schemas"]["deleted_product"]) | null; /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: components["schemas"]["plan_tier"][]; /** + * @nullable * @description Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. * @enum {string|null} */ tiers_mode?: "graduated" | "volume" | null; - /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ + /** + * @nullable + * @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. + */ transform_usage?: components["schemas"]["transform_usage"] | null; - /** @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). */ + /** + * @nullable + * @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + */ trial_period_days?: number | null; /** * @description Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. @@ -21940,21 +25929,32 @@ export interface components { }; /** PlanTier */ plan_tier: { - /** @description Price for the entire tier. */ + /** + * @nullable + * @description Price for the entire tier. + */ flat_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ flat_amount_decimal?: string | null; - /** @description Per unit price for units relevant to the tier. */ + /** + * @nullable + * @description Per unit price for units relevant to the tier. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ unit_amount_decimal?: string | null; - /** @description Up to and including to this quantity will be contained in the tier. */ + /** + * @nullable + * @description Up to and including to this quantity will be contained in the tier. + */ up_to?: number | null; }; /** PlatformEarningFeeSource */ @@ -21971,11 +25971,20 @@ export interface components { }; /** PortalBusinessProfile */ portal_business_profile: { - /** @description The messaging shown to customers in the portal. */ + /** + * @nullable + * @description The messaging shown to customers in the portal. + */ headline?: string | null; - /** @description A link to the business’s publicly available privacy policy. */ + /** + * @nullable + * @description A link to the business’s publicly available privacy policy. + */ privacy_policy_url?: string | null; - /** @description A link to the business’s publicly available terms of service. */ + /** + * @nullable + * @description A link to the business’s publicly available terms of service. + */ terms_of_service_url?: string | null; }; /** PortalCustomerUpdate */ @@ -21995,7 +26004,10 @@ export interface components { }; /** PortalFlowsAfterCompletionHostedConfirmation */ portal_flows_after_completion_hosted_confirmation: { - /** @description A custom message to display to the customer after the flow is completed. */ + /** + * @nullable + * @description A custom message to display to the customer after the flow is completed. + */ custom_message?: string | null; }; /** PortalFlowsAfterCompletionRedirect */ @@ -22011,11 +26023,20 @@ export interface components { /** PortalFlowsFlow */ portal_flows_flow: { after_completion: components["schemas"]["portal_flows_flow_after_completion"]; - /** @description Configuration when `flow.type=subscription_cancel`. */ + /** + * @nullable + * @description Configuration when `flow.type=subscription_cancel`. + */ subscription_cancel?: components["schemas"]["portal_flows_flow_subscription_cancel"] | null; - /** @description Configuration when `flow.type=subscription_update`. */ + /** + * @nullable + * @description Configuration when `flow.type=subscription_update`. + */ subscription_update?: components["schemas"]["portal_flows_flow_subscription_update"] | null; - /** @description Configuration when `flow.type=subscription_update_confirm`. */ + /** + * @nullable + * @description Configuration when `flow.type=subscription_update_confirm`. + */ subscription_update_confirm?: components["schemas"]["portal_flows_flow_subscription_update_confirm"] | null; /** * @description Type of flow that the customer will go through. @@ -22025,9 +26046,15 @@ export interface components { }; /** PortalFlowsFlowAfterCompletion */ portal_flows_flow_after_completion: { - /** @description Configuration when `after_completion.type=hosted_confirmation`. */ + /** + * @nullable + * @description Configuration when `after_completion.type=hosted_confirmation`. + */ hosted_confirmation?: components["schemas"]["portal_flows_after_completion_hosted_confirmation"] | null; - /** @description Configuration when `after_completion.type=redirect`. */ + /** + * @nullable + * @description Configuration when `after_completion.type=redirect`. + */ redirect?: components["schemas"]["portal_flows_after_completion_redirect"] | null; /** * @description The specified type of behavior after the flow is completed. @@ -22037,7 +26064,10 @@ export interface components { }; /** PortalFlowsFlowSubscriptionCancel */ portal_flows_flow_subscription_cancel: { - /** @description Specify a retention strategy to be used in the cancellation flow. */ + /** + * @nullable + * @description Specify a retention strategy to be used in the cancellation flow. + */ retention?: components["schemas"]["portal_flows_retention"] | null; /** @description The ID of the subscription to be canceled. */ subscription: string; @@ -22049,7 +26079,10 @@ export interface components { }; /** PortalFlowsFlowSubscriptionUpdateConfirm */ portal_flows_flow_subscription_update_confirm: { - /** @description The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified. */ + /** + * @nullable + * @description The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified. + */ discounts?: components["schemas"]["portal_flows_subscription_update_confirm_discount"][] | null; /** @description The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. */ items: components["schemas"]["portal_flows_subscription_update_confirm_item"][]; @@ -22058,7 +26091,10 @@ export interface components { }; /** PortalFlowsRetention */ portal_flows_retention: { - /** @description Configuration when `retention.type=coupon_offer`. */ + /** + * @nullable + * @description Configuration when `retention.type=coupon_offer`. + */ coupon_offer?: components["schemas"]["portal_flows_coupon_offer"] | null; /** * @description Type of retention strategy that will be used. @@ -22068,16 +26104,28 @@ export interface components { }; /** PortalFlowsSubscriptionUpdateConfirmDiscount */ portal_flows_subscription_update_confirm_discount: { - /** @description The ID of the coupon to apply to this subscription update. */ + /** + * @nullable + * @description The ID of the coupon to apply to this subscription update. + */ coupon?: string | null; - /** @description The ID of a promotion code to apply to this subscription update. */ + /** + * @nullable + * @description The ID of a promotion code to apply to this subscription update. + */ promotion_code?: string | null; }; /** PortalFlowsSubscriptionUpdateConfirmItem */ portal_flows_subscription_update_confirm_item: { - /** @description The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. */ + /** + * @nullable + * @description The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. + */ id?: string | null; - /** @description The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). */ + /** + * @nullable + * @description The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). + */ price?: string | null; /** @description [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow. */ quantity?: number; @@ -22095,7 +26143,10 @@ export interface components { * If `false`, the previously generated `url`, if any, will be deactivated. */ enabled: boolean; - /** @description A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal. */ + /** + * @nullable + * @description A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal. + */ url?: string | null; }; /** PortalPaymentMethodUpdate */ @@ -22145,7 +26196,10 @@ export interface components { default_allowed_updates: ("price" | "promotion_code" | "quantity")[]; /** @description Whether the feature is enabled. */ enabled: boolean; - /** @description The list of up to 10 products that support subscription updates. */ + /** + * @nullable + * @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`. Defaults to a value of `none` if you don't set it during creation. @@ -22179,32 +26233,41 @@ export interface components { */ billing_scheme: "per_unit" | "tiered"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { [key: string]: components["schemas"]["currency_option"]; }; - /** @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. */ + /** + * @nullable + * @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. + */ custom_unit_amount?: components["schemas"]["custom_unit_amount"] | null; /** @description 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 A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ + /** + * @nullable + * @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. + */ lookup_key?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { [key: string]: string; }; - /** @description A brief description of the price, hidden from customers. */ + /** + * @nullable + * @description A brief description of the price, hidden from customers. + */ nickname?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -22213,9 +26276,13 @@ export interface components { object: "price"; /** @description The ID of the product this price is associated with. */ product: string | components["schemas"]["product"] | components["schemas"]["deleted_product"]; - /** @description The recurring components of a price such as `interval` and `usage_type`. */ + /** + * @nullable + * @description The recurring components of a price such as `interval` and `usage_type`. + */ recurring?: components["schemas"]["recurring"] | null; /** + * @nullable * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string|null} */ @@ -22223,42 +26290,61 @@ export interface components { /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: components["schemas"]["price_tier"][]; /** + * @nullable * @description Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. * @enum {string|null} */ tiers_mode?: "graduated" | "volume" | null; - /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ + /** + * @nullable + * @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. + */ transform_quantity?: components["schemas"]["transform_quantity"] | null; /** * @description One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. * @enum {string} */ type: "one_time" | "recurring"; - /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /** + * @nullable + * @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * @format decimal */ unit_amount_decimal?: string | null; }; /** PriceTier */ price_tier: { - /** @description Price for the entire tier. */ + /** + * @nullable + * @description Price for the entire tier. + */ flat_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ flat_amount_decimal?: string | null; - /** @description Per unit price for units relevant to the tier. */ + /** + * @nullable + * @description Per unit price for units relevant to the tier. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ unit_amount_decimal?: string | null; - /** @description Up to and including to this quantity will be contained in the tier. */ + /** + * @nullable + * @description Up to and including to this quantity will be contained in the tier. + */ up_to?: number | null; }; /** @@ -22276,13 +26362,19 @@ export interface components { /** @description Whether the product is currently available for purchase. */ active: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. */ + /** + * @nullable + * @description The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. + */ default_price?: (string | components["schemas"]["price"]) | null; - /** @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ + /** + * @nullable + * @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. + */ description?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -22303,22 +26395,40 @@ export interface components { * @enum {string} */ object: "product"; - /** @description The dimensions of this product for shipping purposes. */ + /** + * @nullable + * @description The dimensions of this product for shipping purposes. + */ package_dimensions?: components["schemas"]["package_dimensions"] | null; - /** @description Whether this product is shipped (i.e., physical goods). */ + /** + * @nullable + * @description Whether this product is shipped (i.e., physical goods). + */ shippable?: boolean | null; - /** @description Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments. */ + /** + * @nullable + * @description Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments. + */ statement_descriptor?: string | null; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. */ + /** + * @nullable + * @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + */ tax_code?: (string | components["schemas"]["tax_code"]) | null; - /** @description A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. */ + /** + * @nullable + * @description A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. + */ unit_label?: string | null; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; - /** @description A URL of a publicly-accessible webpage for this product. */ + /** + * @nullable + * @description A URL of a publicly-accessible webpage for this product. + */ url?: string | null; }; /** @@ -22355,24 +26465,34 @@ export interface components { code: string; coupon: components["schemas"]["coupon"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The customer that this promotion code can be used by. */ + /** + * @nullable + * @description The customer that this promotion code can be used by. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** - * Format: unix-time + * @nullable * @description Date at which the promotion code can no longer be redeemed. + * @format unix-time */ 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 Maximum number of times this promotion code can be redeemed. */ + /** + * @nullable + * @description Maximum number of times this promotion code can be redeemed. + */ max_redemptions?: number | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -22398,9 +26518,15 @@ export interface components { }; /** @description A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices */ first_time_transaction: boolean; - /** @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ + /** + * @nullable + * @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). + */ minimum_amount?: number | null; - /** @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount */ + /** + * @nullable + * @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount + */ minimum_amount_currency?: string | null; }; /** @@ -22413,11 +26539,20 @@ export interface components { amount_subtotal: number; /** @description Total after discounts and taxes are applied. */ amount_total: number; - /** @description ID of the Connect Application that created the quote. */ + /** + * @nullable + * @description ID of the Connect Application that created the quote. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. */ + /** + * @nullable + * @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. + */ application_fee_amount?: number | null; - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. + */ application_fee_percent?: number | null; automatic_tax: components["schemas"]["quotes_resource_automatic_tax"]; /** @@ -22427,34 +26562,55 @@ export interface components { collection_method: "charge_automatically" | "send_invoice"; computed: components["schemas"]["quotes_resource_computed"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ 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). */ + /** + * @nullable + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string | null; - /** @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ + /** + * @nullable + * @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** @description The tax rates applied to this quote. */ default_tax_rates?: (string | components["schemas"]["tax_rate"])[]; - /** @description A description that will be displayed on the quote PDF. */ + /** + * @nullable + * @description A description that will be displayed on the quote PDF. + */ description?: string | null; /** @description The discounts applied to this quote. */ discounts: (string | components["schemas"]["discount"])[]; /** - * Format: unix-time * @description The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. + * @format unix-time */ expires_at: number; - /** @description A footer that will be displayed on the quote PDF. */ + /** + * @nullable + * @description A footer that will be displayed on the quote PDF. + */ footer?: string | null; - /** @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. */ + /** + * @nullable + * @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. + */ from_quote?: components["schemas"]["quotes_resource_from_quote"] | null; - /** @description A header that will be displayed on the quote PDF. */ + /** + * @nullable + * @description A header that will be displayed on the quote PDF. + */ header?: string | null; /** @description Unique identifier for the object. */ id: string; - /** @description The invoice that was created from this quote. */ + /** + * @nullable + * @description The invoice that was created from this quote. + */ invoice?: (string | components["schemas"]["invoice"] | components["schemas"]["deleted_invoice"]) | null; invoice_settings: components["schemas"]["invoice_setting_quote_setting"]; /** @@ -22480,14 +26636,20 @@ export interface components { metadata: { [key: string]: string; }; - /** @description A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). */ + /** + * @nullable + * @description A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). + */ number?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "quote"; - /** @description The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. */ + /** + * @nullable + * @description The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** * @description The status of the quote. @@ -22495,24 +26657,40 @@ export interface components { */ status: "accepted" | "canceled" | "draft" | "open"; status_transitions: components["schemas"]["quotes_resource_status_transitions"]; - /** @description The subscription that was created or updated from this quote. */ + /** + * @nullable + * @description The subscription that was created or updated from this quote. + */ subscription?: (string | components["schemas"]["subscription"]) | null; subscription_data: components["schemas"]["quotes_resource_subscription_data_subscription_data"]; - /** @description The subscription schedule that was created or updated from this quote. */ + /** + * @nullable + * @description The subscription schedule that was created or updated from this quote. + */ subscription_schedule?: (string | components["schemas"]["subscription_schedule"]) | null; - /** @description ID of the test clock this quote belongs to. */ + /** + * @nullable + * @description ID of the test clock this quote belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; total_details: components["schemas"]["quotes_resource_total_details"]; - /** @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. */ + /** + * @nullable + * @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. + */ transfer_data?: components["schemas"]["quotes_resource_transfer_data"] | null; }; /** QuotesResourceAutomaticTax */ quotes_resource_automatic_tax: { /** @description Automatically calculate taxes */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; /** + * @nullable * @description The status of the most recent automated tax calculation for this quote. * @enum {string|null} */ @@ -22520,7 +26698,10 @@ export interface components { }; /** QuotesResourceComputed */ quotes_resource_computed: { - /** @description The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices. */ + /** + * @nullable + * @description The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices. + */ recurring?: components["schemas"]["quotes_resource_recurring"] | null; upfront: components["schemas"]["quotes_resource_upfront"]; }; @@ -22549,42 +26730,58 @@ export interface components { /** QuotesResourceStatusTransitions */ quotes_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description The time that the quote was accepted. Measured in seconds since Unix epoch. + * @format unix-time */ accepted_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the quote was canceled. Measured in seconds since Unix epoch. + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the quote was finalized. Measured in seconds since Unix epoch. + * @format unix-time */ finalized_at?: number | null; }; /** 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 for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @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 + * @nullable * @description When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch. + * @format unix-time */ 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. */ + /** + * @nullable + * @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; } | null; - /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ + /** + * @nullable + * @description Integer representing the number of trial period days before the customer is charged for the first time. + */ trial_period_days?: number | null; }; /** QuotesResourceTotalDetails */ quotes_resource_total_details: { /** @description This is the sum of all the discounts. */ amount_discount: number; - /** @description This is the sum of all the shipping amounts. */ + /** + * @nullable + * @description This is the sum of all the shipping amounts. + */ amount_shipping?: number | null; /** @description This is the sum of all the tax amounts. */ amount_tax: number; @@ -22599,9 +26796,15 @@ export interface components { }; /** QuotesResourceTransferData */ quotes_resource_transfer_data: { - /** @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ + /** + * @nullable + * @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. + */ amount?: number | null; - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. + */ amount_percent?: number | null; /** @description The account where funds from the payment will be transferred to upon payment success. */ destination: string | components["schemas"]["account"]; @@ -22644,8 +26847,8 @@ export interface components { /** @description ID of the charge this early fraud warning is for, optionally expanded. */ charge: string | components["schemas"]["charge"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. */ @@ -22672,8 +26875,8 @@ export interface components { /** @description The name of the value list for use in rules. */ alias: string; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The name or email address of the user who created this value list. */ @@ -22724,8 +26927,8 @@ export interface components { */ "radar.value_list_item": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The name or email address of the user who added this item to the value list. */ @@ -22754,26 +26957,53 @@ export interface components { }; /** RadarReviewResourceLocation */ radar_review_resource_location: { - /** @description The city where the payment originated. */ + /** + * @nullable + * @description The city where the payment originated. + */ city?: string | null; - /** @description Two-letter ISO code representing the country where the payment originated. */ + /** + * @nullable + * @description Two-letter ISO code representing the country where the payment originated. + */ country?: string | null; - /** @description The geographic latitude where the payment originated. */ + /** + * @nullable + * @description The geographic latitude where the payment originated. + */ latitude?: number | null; - /** @description The geographic longitude where the payment originated. */ + /** + * @nullable + * @description The geographic longitude where the payment originated. + */ longitude?: number | null; - /** @description The state/county/province/region where the payment originated. */ + /** + * @nullable + * @description The state/county/province/region where the payment originated. + */ region?: string | null; }; /** RadarReviewResourceSession */ radar_review_resource_session: { - /** @description The browser used in this browser session (e.g., `Chrome`). */ + /** + * @nullable + * @description The browser used in this browser session (e.g., `Chrome`). + */ browser?: string | null; - /** @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ + /** + * @nullable + * @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). + */ device?: string | null; - /** @description The platform for the browser session (e.g., `Macintosh`). */ + /** + * @nullable + * @description The platform for the browser session (e.g., `Macintosh`). + */ platform?: string | null; - /** @description The version for the browser session (e.g., `61.0.3163.100`). */ + /** + * @nullable + * @description The version for the browser session (e.g., `61.0.3163.100`). + */ version?: string | null; }; /** received_payment_method_details_financial_account */ @@ -22789,6 +27019,7 @@ export interface components { /** Recurring */ recurring: { /** + * @nullable * @description Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`. * @enum {string|null} */ @@ -22800,7 +27031,10 @@ export interface components { interval: "day" | "month" | "week" | "year"; /** @description The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ interval_count: number; - /** @description The meter tracking the usage of a metered price */ + /** + * @nullable + * @description The meter tracking the usage of a metered price + */ meter?: string | null; /** * @description Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. @@ -22819,18 +27053,24 @@ export interface components { refund: { /** @description Amount, in cents (or local equivalent). */ amount: number; - /** @description Balance transaction that describes the impact on your account balance. */ + /** + * @nullable + * @description Balance transaction that describes the impact on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; - /** @description ID of the charge that's refunded. */ + /** + * @nullable + * @description ID of the charge that's refunded. + */ charge?: (string | components["schemas"]["charge"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). */ @@ -22844,7 +27084,10 @@ export interface components { id: string; /** @description For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. */ instructions_email?: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -22854,20 +27097,36 @@ export interface components { * @enum {string} */ object: "refund"; - /** @description ID of the PaymentIntent that's refunded. */ + /** + * @nullable + * @description ID of the PaymentIntent that's refunded. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; /** + * @nullable * @description Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). * @enum {string|null} */ reason?: "duplicate" | "expired_uncaptured_charge" | "fraudulent" | "requested_by_customer" | null; - /** @description This is the transaction number that appears on email receipts sent for this refund. */ + /** + * @nullable + * @description This is the transaction number that appears on email receipts sent for this refund. + */ receipt_number?: string | null; - /** @description The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. */ + /** + * @nullable + * @description The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. + */ source_transfer_reversal?: (string | components["schemas"]["transfer_reversal"]) | null; - /** @description Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). */ + /** + * @nullable + * @description Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). + */ status?: string | null; - /** @description This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. */ + /** + * @nullable + * @description This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. + */ transfer_reversal?: (string | components["schemas"]["transfer_reversal"]) | null; }; /** refund_destination_details */ @@ -22908,18 +27167,33 @@ export interface components { }; /** refund_destination_details_blik */ refund_destination_details_blik: { - /** @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. */ + /** + * @nullable + * @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. + */ network_decline_code?: string | null; - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_br_bank_transfer */ refund_destination_details_br_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_card */ @@ -22938,67 +27212,124 @@ export interface components { }; /** refund_destination_details_eu_bank_transfer */ refund_destination_details_eu_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_gb_bank_transfer */ refund_destination_details_gb_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_jp_bank_transfer */ refund_destination_details_jp_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_multibanco */ refund_destination_details_multibanco: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_mx_bank_transfer */ refund_destination_details_mx_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_p24 */ refund_destination_details_p24: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_swish */ refund_destination_details_swish: { - /** @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. */ + /** + * @nullable + * @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. + */ network_decline_code?: string | null; - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_th_bank_transfer */ refund_destination_details_th_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_us_bank_transfer */ refund_destination_details_us_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** RefundNextAction */ @@ -23011,8 +27342,8 @@ export interface components { refund_next_action_display_details: { email_sent: components["schemas"]["email_sent"]; /** - * Format: unix-time * @description The expiry timestamp. + * @format unix-time */ expires_at: number; }; @@ -23029,11 +27360,12 @@ export interface components { */ "reporting.report_run": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** + * @nullable * @description If something should go wrong during the run, a message about the failure (populated when * `status=failed`). */ @@ -23051,6 +27383,7 @@ export interface components { /** @description The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. */ report_type: string; /** + * @nullable * @description The file object representing the result of the report run (populated when * `status=succeeded`). */ @@ -23062,9 +27395,10 @@ export interface components { */ status: string; /** - * Format: unix-time + * @nullable * @description Timestamp at which this run successfully finished (populated when * `status=succeeded`). Measured in seconds since the Unix epoch. + * @format unix-time */ succeeded_at?: number | null; }; @@ -23081,16 +27415,19 @@ export interface components { */ "reporting.report_type": { /** - * Format: unix-time * @description Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. + * @format unix-time */ data_available_end: number; /** - * Format: unix-time * @description Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. + * @format unix-time */ data_available_start: number; - /** @description List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.) */ + /** + * @nullable + * @description List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.) + */ default_columns?: string[] | null; /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ id: string; @@ -23104,8 +27441,8 @@ export interface components { */ object: "reporting.report_type"; /** - * Format: unix-time * @description When this Report Type was latest updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; /** @description Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas. */ @@ -23115,11 +27452,14 @@ export interface components { reserve_transaction: { amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -23137,25 +27477,38 @@ export interface components { * [here](https://stripe.com/docs/radar/reviews). */ review: { - /** @description The ZIP or postal code of the card used, if applicable. */ + /** + * @nullable + * @description The ZIP or postal code of the card used, if applicable. + */ billing_zip?: string | null; - /** @description The charge associated with this review. */ + /** + * @nullable + * @description The charge associated with this review. + */ charge?: (string | components["schemas"]["charge"]) | null; /** + * @nullable * @description The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. * @enum {string|null} */ closed_reason?: "approved" | "disputed" | "redacted" | "refunded" | "refunded_as_fraud" | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; - /** @description The IP address where the payment originated. */ + /** + * @nullable + * @description The IP address where the payment originated. + */ ip_address?: string | null; - /** @description Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. */ + /** + * @nullable + * @description Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. + */ ip_address_location?: components["schemas"]["radar_review_resource_location"] | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -23175,13 +27528,17 @@ export interface components { payment_intent?: string | components["schemas"]["payment_intent"]; /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ reason: string; - /** @description Information related to the browsing session of the user who initiated the payment. */ + /** + * @nullable + * @description Information related to the browsing session of the user who initiated the payment. + */ session?: components["schemas"]["radar_review_resource_session"] | null; }; /** revolut_pay_underlying_payment_method_funding_details */ revolut_pay_underlying_payment_method_funding_details: { card?: components["schemas"]["payment_method_details_passthrough_card"]; /** + * @nullable * @description funding type of the underlying payment method. * @enum {string|null} */ @@ -23205,17 +27562,20 @@ export interface components { */ scheduled_query_run: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time * @description When the query was run, Sigma contained a snapshot of your Stripe data at this time. + * @format unix-time */ data_load_time: number; error?: components["schemas"]["sigma_scheduled_query_run_error"]; - /** @description The file object representing the results of the query. */ + /** + * @nullable + * @description The file object representing the results of the query. + */ file?: components["schemas"]["file"] | null; /** @description Unique identifier for the object. */ id: string; @@ -23227,8 +27587,8 @@ export interface components { */ object: "scheduled_query_run"; /** - * Format: unix-time * @description Time at which the result expires and is no longer available for download. + * @format unix-time */ result_available_until: number; /** @description SQL for the query. */ @@ -23241,13 +27601,17 @@ export interface components { /** SchedulesPhaseAutomaticTax */ schedules_phase_automatic_tax: { /** + * @nullable * @description If Stripe disabled automatic tax, this enum describes why. * @enum {string|null} */ disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; }; /** SecretServiceResourceScope */ @@ -23262,9 +27626,15 @@ export interface components { }; /** sepa_debit_generated_from */ sepa_debit_generated_from: { - /** @description The ID of the Charge that generated this PaymentMethod, if any. */ + /** + * @nullable + * @description The ID of the Charge that generated this PaymentMethod, if any. + */ charge?: (string | components["schemas"]["charge"]) | null; - /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ + /** + * @nullable + * @description The ID of the SetupAttempt that generated this PaymentMethod, if any. + */ setup_attempt?: (string | components["schemas"]["setup_attempt"]) | null; }; /** @@ -23275,7 +27645,10 @@ export interface components { * payment method using a SetupIntent. */ setup_attempt: { - /** @description The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. */ + /** + * @nullable + * @description The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. + */ application?: (string | components["schemas"]["application"]) | null; /** * @description If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -23284,13 +27657,17 @@ export interface components { */ attach_to_self?: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. */ + /** + * @nullable + * @description The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** + * @nullable * @description Indicates the directions of money movement for which this payment method is intended to be used. * * Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. @@ -23305,12 +27682,18 @@ export interface components { * @enum {string} */ object: "setup_attempt"; - /** @description The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. */ + /** + * @nullable + * @description The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** @description ID of the payment method used with this SetupAttempt. */ payment_method: string | components["schemas"]["payment_method"]; payment_method_details: components["schemas"]["setup_attempt_payment_method_details"]; - /** @description The error encountered during this attempt to confirm the SetupIntent, if any. */ + /** + * @nullable + * @description The error encountered during this attempt to confirm the SetupIntent, if any. + */ setup_error?: components["schemas"]["api_errors"] | null; /** @description ID of the SetupIntent that this attempt belongs to. */ setup_intent: string | components["schemas"]["setup_intent"]; @@ -23353,25 +27736,45 @@ export interface components { setup_attempt_payment_method_details_bacs_debit: Record; /** setup_attempt_payment_method_details_bancontact */ setup_attempt_payment_method_details_bancontact: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ preferred_language?: "de" | "en" | "fr" | "nl" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -23381,47 +27784,93 @@ export interface components { setup_attempt_payment_method_details_boleto: Record; /** setup_attempt_payment_method_details_card */ setup_attempt_payment_method_details_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ brand?: string | null; - /** @description Check results by Card networks on Card address and CVC at the time of authorization */ + /** + * @nullable + * @description Check results by Card networks on Card address and CVC at the time of authorization + */ checks?: components["schemas"]["setup_attempt_payment_method_details_card_checks"] | null; - /** @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @description Two-digit number representing the card's expiration month. + */ exp_month?: number | null; - /** @description Four-digit number representing the card's expiration year. */ + /** + * @nullable + * @description Four-digit number representing the card's expiration year. + */ exp_year?: number | null; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ network?: string | null; - /** @description Populated if this authorization used 3D Secure authentication. */ + /** + * @nullable + * @description Populated if this authorization used 3D Secure authentication. + */ three_d_secure?: components["schemas"]["three_d_secure_details"] | null; - /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @description The ID of the Card PaymentMethod which was generated by this SetupAttempt. + */ generated_card?: (string | components["schemas"]["payment_method"]) | null; - /** @description Details about payments collected offline. */ + /** + * @nullable + * @description Details about payments collected offline. + */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; }; /** setup_attempt_payment_method_details_card_wallet */ @@ -23439,22 +27888,34 @@ export interface components { /** setup_attempt_payment_method_details_ideal */ setup_attempt_payment_method_details_ideal: { /** + * @nullable * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; /** + * @nullable * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -23476,25 +27937,45 @@ export interface components { setup_attempt_payment_method_details_sepa_debit: Record; /** setup_attempt_payment_method_details_sofort */ setup_attempt_payment_method_details_sofort: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Preferred language of the Sofort authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ preferred_language?: "de" | "en" | "fr" | "nl" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Sofort directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -23527,7 +28008,10 @@ export interface components { * Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) */ setup_intent: { - /** @description ID of the Connect application that created the SetupIntent. */ + /** + * @nullable + * @description ID of the Connect application that created the SetupIntent. + */ application?: (string | components["schemas"]["application"]) | null; /** * @description If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -23535,33 +28019,43 @@ export interface components { * It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. */ attach_to_self?: boolean; - /** @description Settings for dynamic payment methods compatible with this Setup Intent */ + /** + * @nullable + * @description Settings for dynamic payment methods compatible with this Setup Intent + */ automatic_payment_methods?: components["schemas"]["payment_flows_automatic_payment_methods_setup_intent"] | null; /** + * @nullable * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. * @enum {string|null} */ cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer" | null; /** + * @nullable * @description The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. */ client_secret?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** + * @nullable * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** + * @nullable * @description Indicates the directions of money movement for which this payment method is intended to be used. * * Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. @@ -23569,36 +28063,66 @@ export interface components { flow_directions?: ("inbound" | "outbound")[] | null; /** @description Unique identifier for the object. */ id: string; - /** @description The error encountered in the previous SetupIntent confirmation. */ + /** + * @nullable + * @description The error encountered in the previous SetupIntent confirmation. + */ last_setup_error?: components["schemas"]["api_errors"] | null; - /** @description The most recent SetupAttempt for this SetupIntent. */ + /** + * @nullable + * @description The most recent SetupAttempt for this SetupIntent. + */ latest_attempt?: (string | components["schemas"]["setup_attempt"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description ID of the multi use Mandate generated by the SetupIntent. */ + /** + * @nullable + * @description ID of the multi use Mandate generated by the SetupIntent. + */ mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */ + /** + * @nullable + * @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. + */ next_action?: components["schemas"]["setup_intent_next_action"] | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "setup_intent"; - /** @description The account (if any) for which the setup is intended. */ + /** + * @nullable + * @description The account (if any) for which the setup is intended. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. */ + /** + * @nullable + * @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. + */ payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent. */ + /** + * @nullable + * @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent. + */ payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; - /** @description Payment method-specific configuration for this SetupIntent. */ + /** + * @nullable + * @description Payment method-specific configuration for this SetupIntent. + */ payment_method_options?: components["schemas"]["setup_intent_payment_method_options"] | null; /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ payment_method_types: string[]; - /** @description ID of the single_use Mandate generated by the SetupIntent. */ + /** + * @nullable + * @description ID of the single_use Mandate generated by the SetupIntent. + */ single_use_mandate?: (string | components["schemas"]["mandate"]) | null; /** * @description [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. @@ -23624,21 +28148,28 @@ export interface components { }; /** SetupIntentNextActionRedirectToUrl */ setup_intent_next_action_redirect_to_url: { - /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ + /** + * @nullable + * @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. + */ return_url?: string | null; - /** @description The URL you must redirect your customer to in order to authenticate. */ + /** + * @nullable + * @description The URL you must redirect your customer to in order to authenticate. + */ url?: string | null; }; /** SetupIntentNextActionVerifyWithMicrodeposits */ setup_intent_next_action_verify_with_microdeposits: { /** - * Format: unix-time * @description The timestamp when the microdeposits are expected to land. + * @format unix-time */ arrival_date: number; /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ hosted_verification_url: string; /** + * @nullable * @description The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. * @enum {string|null} */ @@ -23659,6 +28190,7 @@ export interface components { /** setup_intent_payment_method_options_acss_debit */ setup_intent_payment_method_options_acss_debit: { /** + * @nullable * @description Currency supported by the bank account * @enum {string|null} */ @@ -23678,14 +28210,19 @@ export interface components { }; /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { - /** @description Configuration options for setting up an eMandate for cards issued in India. */ + /** + * @nullable + * @description Configuration options for setting up an eMandate for cards issued in India. + */ mandate_options?: components["schemas"]["setup_intent_payment_method_options_card_mandate_options"] | null; /** + * @nullable * @description Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. * @enum {string|null} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** + * @nullable * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ @@ -23701,15 +28238,19 @@ export interface components { */ amount_type: "fixed" | "maximum"; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ + /** + * @nullable + * @description A description of the mandate or subscription that is meant to be displayed to the customer. + */ description?: string | null; /** - * Format: unix-time + * @nullable * @description End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. + * @format unix-time */ end_date?: number | null; /** @@ -23717,16 +28258,22 @@ export interface components { * @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; - /** @description The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. */ + /** + * @nullable + * @description The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. + */ interval_count?: number | null; /** @description Unique identifier for the mandate or subscription. */ reference: string; /** - * Format: unix-time * @description Start date of the mandate or subscription. Start date should not be lesser than yesterday. + * @format unix-time */ start_date: number; - /** @description Specifies the type of mandates supported. Possible values are `india`. */ + /** + * @nullable + * @description Specifies the type of mandates supported. Possible values are `india`. + */ supported_types?: "india"[] | null; }; /** setup_intent_payment_method_options_card_present */ @@ -23739,14 +28286,19 @@ export interface components { custom_mandate_url?: string; /** @description List of Stripe products where this mandate can be selected automatically. */ default_for?: ("invoice" | "subscription")[]; - /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /** + * @nullable + * @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. + */ interval_description?: string | null; /** + * @nullable * @description Payment schedule for the mandate. * @enum {string|null} */ payment_schedule?: "combined" | "interval" | "sporadic" | null; /** + * @nullable * @description Transaction type of the mandate. * @enum {string|null} */ @@ -23764,7 +28316,10 @@ export interface components { }; /** setup_intent_payment_method_options_paypal */ setup_intent_payment_method_options_paypal: { - /** @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. */ + /** + * @nullable + * @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. + */ billing_agreement_id?: string | null; }; /** setup_intent_payment_method_options_sepa_debit */ @@ -23792,13 +28347,22 @@ export interface components { /** Shipping */ shipping: { address?: components["schemas"]["address"]; - /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ + /** + * @nullable + * @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. + */ carrier?: string | null; /** @description Recipient name. */ name?: string; - /** @description Recipient phone (including extension). */ + /** + * @nullable + * @description Recipient phone (including extension). + */ phone?: string | null; - /** @description The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. */ + /** + * @nullable + * @description The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. + */ tracking_number?: string | null; }; /** @@ -23810,13 +28374,19 @@ export interface components { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ active: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. */ + /** + * @nullable + * @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. + */ delivery_estimate?: components["schemas"]["shipping_rate_delivery_estimate"] | null; - /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ + /** + * @nullable + * @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. + */ display_name?: string | null; fixed_amount?: components["schemas"]["shipping_rate_fixed_amount"]; /** @description Unique identifier for the object. */ @@ -23833,11 +28403,15 @@ export interface components { */ object: "shipping_rate"; /** + * @nullable * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string|null} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified" | null; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. */ + /** + * @nullable + * @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + */ tax_code?: (string | components["schemas"]["tax_code"]) | null; /** * @description The type of calculation to use on the shipping rate. @@ -23857,9 +28431,15 @@ export interface components { }; /** ShippingRateDeliveryEstimate */ shipping_rate_delivery_estimate: { - /** @description The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. */ + /** + * @nullable + * @description The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. + */ maximum?: components["schemas"]["shipping_rate_delivery_estimate_bound"] | null; - /** @description The lower bound of the estimated range. If empty, represents no lower bound. */ + /** + * @nullable + * @description The lower bound of the estimated range. If empty, represents no lower bound. + */ minimum?: components["schemas"]["shipping_rate_delivery_estimate_bound"] | null; }; /** ShippingRateDeliveryEstimateBound */ @@ -23877,8 +28457,8 @@ export interface components { /** @description A non-negative integer in cents representing how much to charge. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ @@ -23910,11 +28490,15 @@ export interface components { acss_debit?: components["schemas"]["source_type_acss_debit"]; alipay?: components["schemas"]["source_type_alipay"]; /** + * @nullable * @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. * @enum {string|null} */ allow_redisplay?: "always" | "limited" | "unspecified" | null; - /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. */ + /** + * @nullable + * @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. + */ amount?: number | null; au_becs_debit?: components["schemas"]["source_type_au_becs_debit"]; bancontact?: components["schemas"]["source_type_bancontact"]; @@ -23924,13 +28508,14 @@ export interface components { client_secret: string; code_verification?: components["schemas"]["source_code_verification_flow"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency + * @nullable * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. + * @format currency */ currency?: string | null; /** @description The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. */ @@ -23945,7 +28530,10 @@ export interface components { klarna?: components["schemas"]["source_type_klarna"]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -23955,7 +28543,10 @@ export interface components { * @enum {string} */ object: "source"; - /** @description Information about the owner of the payment instrument that may be used or required by particular source types. */ + /** + * @nullable + * @description Information about the owner of the payment instrument that may be used or required by particular source types. + */ owner?: components["schemas"]["source_owner"] | null; p24?: components["schemas"]["source_type_p24"]; receiver?: components["schemas"]["source_receiver_flow"]; @@ -23963,7 +28554,10 @@ export interface components { sepa_debit?: components["schemas"]["source_type_sepa_debit"]; sofort?: components["schemas"]["source_type_sofort"]; source_order?: components["schemas"]["source_order"]; - /** @description Extra information about a source. This will appear on your customer's statement every time you charge the source. */ + /** + * @nullable + * @description Extra information about a source. This will appear on your customer's statement every time you charge the source. + */ statement_descriptor?: string | null; /** @description The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ status: string; @@ -23973,7 +28567,10 @@ export interface components { * @enum {string} */ type: "ach_credit_transfer" | "ach_debit" | "acss_debit" | "alipay" | "au_becs_debit" | "bancontact" | "card" | "card_present" | "eps" | "giropay" | "ideal" | "klarna" | "multibanco" | "p24" | "sepa_debit" | "sofort" | "three_d_secure" | "wechat"; - /** @description Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. */ + /** + * @nullable + * @description Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. + */ usage?: string | null; wechat?: components["schemas"]["source_type_wechat"]; }; @@ -23992,12 +28589,15 @@ export interface components { */ source_mandate_notification: { acss_debit?: components["schemas"]["source_mandate_notification_acss_debit_data"]; - /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`. */ + /** + * @nullable + * @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`. + */ amount?: number | null; bacs_debit?: components["schemas"]["source_mandate_notification_bacs_debit_data"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ @@ -24042,53 +28642,98 @@ export interface components { /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The email address of the customer placing the order. */ email?: string; - /** @description List of items constituting the order. */ + /** + * @nullable + * @description List of items constituting the order. + */ items?: components["schemas"]["source_order_item"][] | null; shipping?: components["schemas"]["shipping"]; }; /** SourceOrderItem */ source_order_item: { - /** @description The amount (price) for this order item. */ + /** + * @nullable + * @description The amount (price) for this order item. + */ amount?: number | null; - /** @description This currency of this order item. Required when `amount` is present. */ + /** + * @nullable + * @description This currency of this order item. Required when `amount` is present. + */ currency?: string | null; - /** @description Human-readable description for this order item. */ + /** + * @nullable + * @description Human-readable description for this order item. + */ description?: string | null; - /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ + /** + * @nullable + * @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). + */ parent?: string | null; /** @description The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ quantity?: number; - /** @description The type of this order item. Must be `sku`, `tax`, or `shipping`. */ + /** + * @nullable + * @description The type of this order item. Must be `sku`, `tax`, or `shipping`. + */ type?: string | null; }; /** SourceOwner */ source_owner: { - /** @description Owner's address. */ + /** + * @nullable + * @description Owner's address. + */ address?: components["schemas"]["address"] | null; - /** @description Owner's email address. */ + /** + * @nullable + * @description Owner's email address. + */ email?: string | null; - /** @description Owner's full name. */ + /** + * @nullable + * @description Owner's full name. + */ name?: string | null; - /** @description Owner's phone number (including extension). */ + /** + * @nullable + * @description Owner's phone number (including extension). + */ phone?: string | null; - /** @description Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ verified_address?: components["schemas"]["address"] | null; - /** @description Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ verified_email?: string | null; - /** @description Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ verified_name?: string | null; - /** @description Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ verified_phone?: string | null; }; /** SourceReceiverFlow */ source_receiver_flow: { - /** @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ + /** + * @nullable + * @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. + */ address?: string | null; /** @description The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. */ amount_charged: number; @@ -24103,7 +28748,10 @@ export interface components { }; /** SourceRedirectFlow */ source_redirect_flow: { - /** @description The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. */ + /** + * @nullable + * @description The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. + */ failure_reason?: string | null; /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ return_url: string; @@ -24125,13 +28773,13 @@ export interface components { amount: number; chf_credit_transfer?: components["schemas"]["source_transaction_chf_credit_transfer_data"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; gbp_credit_transfer?: components["schemas"]["source_transaction_gbp_credit_transfer_data"]; @@ -24214,112 +28862,184 @@ export interface components { sender_name?: string; }; source_type_ach_credit_transfer: { + /** @nullable */ account_number?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ refund_account_holder_name?: string | null; + /** @nullable */ refund_account_holder_type?: string | null; + /** @nullable */ refund_routing_number?: string | null; + /** @nullable */ routing_number?: string | null; + /** @nullable */ swift_code?: string | null; }; source_type_ach_debit: { + /** @nullable */ bank_name?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ routing_number?: string | null; + /** @nullable */ type?: string | null; }; source_type_acss_debit: { + /** @nullable */ bank_address_city?: string | null; + /** @nullable */ bank_address_line_1?: string | null; + /** @nullable */ bank_address_line_2?: string | null; + /** @nullable */ bank_address_postal_code?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ category?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ routing_number?: string | null; }; source_type_alipay: { + /** @nullable */ data_string?: string | null; + /** @nullable */ native_url?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_au_becs_debit: { + /** @nullable */ bsb_number?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ last4?: string | null; }; source_type_bancontact: { + /** @nullable */ bank_code?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ bic?: string | null; + /** @nullable */ iban_last4?: string | null; + /** @nullable */ preferred_language?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_card: { + /** @nullable */ address_line1_check?: string | null; + /** @nullable */ address_zip_check?: string | null; + /** @nullable */ brand?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ cvc_check?: string | null; + /** @nullable */ dynamic_last4?: string | null; + /** @nullable */ exp_month?: number | null; + /** @nullable */ exp_year?: number | null; fingerprint?: string; + /** @nullable */ funding?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ name?: string | null; three_d_secure?: string; + /** @nullable */ tokenization_method?: string | null; }; source_type_card_present: { application_cryptogram?: string; application_preferred_name?: string; + /** @nullable */ authorization_code?: string | null; authorization_response_code?: string; + /** @nullable */ brand?: string | null; + /** @nullable */ country?: string | null; cvm_type?: string; + /** @nullable */ data_type?: string | null; dedicated_file_name?: string; emv_auth_data?: string; + /** @nullable */ evidence_customer_signature?: string | null; + /** @nullable */ evidence_transaction_certificate?: string | null; + /** @nullable */ exp_month?: number | null; + /** @nullable */ exp_year?: number | null; fingerprint?: string; + /** @nullable */ funding?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ pos_device_id?: string | null; pos_entry_mode?: string; + /** @nullable */ read_method?: string | null; + /** @nullable */ reader?: string | null; terminal_verification_results?: string; transaction_status_information?: string; }; source_type_eps: { + /** @nullable */ reference?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_giropay: { + /** @nullable */ bank_code?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ bic?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_ideal: { + /** @nullable */ bank?: string | null; + /** @nullable */ bic?: string | null; + /** @nullable */ iban_last4?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_klarna: { background_image_url?: string; + /** @nullable */ client_token?: string | null; first_name?: string; last_name?: string; @@ -24347,59 +29067,100 @@ export interface components { shipping_last_name?: string; }; source_type_multibanco: { + /** @nullable */ entity?: string | null; + /** @nullable */ reference?: string | null; + /** @nullable */ refund_account_holder_address_city?: string | null; + /** @nullable */ refund_account_holder_address_country?: string | null; + /** @nullable */ refund_account_holder_address_line1?: string | null; + /** @nullable */ refund_account_holder_address_line2?: string | null; + /** @nullable */ refund_account_holder_address_postal_code?: string | null; + /** @nullable */ refund_account_holder_address_state?: string | null; + /** @nullable */ refund_account_holder_name?: string | null; + /** @nullable */ refund_iban?: string | null; }; source_type_p24: { + /** @nullable */ reference?: string | null; }; source_type_sepa_debit: { + /** @nullable */ bank_code?: string | null; + /** @nullable */ branch_code?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ mandate_reference?: string | null; + /** @nullable */ mandate_url?: string | null; }; source_type_sofort: { + /** @nullable */ bank_code?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ bic?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ iban_last4?: string | null; + /** @nullable */ preferred_language?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_three_d_secure: { + /** @nullable */ address_line1_check?: string | null; + /** @nullable */ address_zip_check?: string | null; + /** @nullable */ authenticated?: boolean | null; + /** @nullable */ brand?: string | null; + /** @nullable */ card?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ customer?: string | null; + /** @nullable */ cvc_check?: string | null; + /** @nullable */ dynamic_last4?: string | null; + /** @nullable */ exp_month?: number | null; + /** @nullable */ exp_year?: number | null; fingerprint?: string; + /** @nullable */ funding?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ name?: string | null; three_d_secure?: string; + /** @nullable */ tokenization_method?: string | null; }; source_type_wechat: { prepay_id?: string; + /** @nullable */ qr_code_url?: string | null; statement_descriptor?: string; }; @@ -24410,33 +29171,50 @@ export interface components { * Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating) */ subscription: { - /** @description ID of the Connect Application that created the subscription. */ + /** + * @nullable + * @description ID of the Connect Application that created the subscription. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. + */ application_fee_percent?: number | null; automatic_tax: components["schemas"]["subscription_automatic_tax"]; /** - * Format: unix-time * @description The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. + * @format unix-time */ billing_cycle_anchor: number; - /** @description The fixed values used to calculate the `billing_cycle_anchor`. */ + /** + * @nullable + * @description The fixed values used to calculate the `billing_cycle_anchor`. + */ billing_cycle_anchor_config?: components["schemas"]["subscriptions_resource_billing_cycle_anchor_config"] | null; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_billing_thresholds"] | null; /** - * Format: unix-time + * @nullable * @description A date in the future at which the subscription will automatically get canceled + * @format unix-time */ cancel_at?: number | null; /** @description Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. */ cancel_at_period_end: boolean; /** - * Format: unix-time + * @nullable * @description If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. + * @format unix-time */ canceled_at?: number | null; - /** @description Details about why this subscription was cancelled */ + /** + * @nullable + * @description Details about why this subscription was cancelled + */ cancellation_details?: components["schemas"]["cancellation_details"] | null; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. @@ -24444,44 +29222,63 @@ export interface components { */ collection_method: "charge_automatically" | "send_invoice"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** - * Format: unix-time * @description End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. + * @format unix-time */ current_period_end: number; /** - * Format: unix-time * @description Start of the current period that the subscription has been invoiced for. + * @format unix-time */ current_period_start: number; /** @description ID of the customer who owns the subscription. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; - /** @description Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. */ + /** + * @nullable + * @description Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. + */ days_until_due?: number | null; - /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** + * @nullable + * @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** + * @nullable + * @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + */ default_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. */ + /** + * @nullable + * @description The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. + */ default_tax_rates?: components["schemas"]["tax_rate"][] | null; - /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. + */ description?: string | null; - /** @description Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ + /** + * @nullable + * @description Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. + */ discount?: components["schemas"]["discount"] | null; /** @description The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ discounts: (string | components["schemas"]["discount"])[]; /** - * Format: unix-time + * @nullable * @description If the subscription has ended, the date the subscription ended. + * @format unix-time */ ended_at?: number | null; /** @description Unique identifier for the object. */ @@ -24504,7 +29301,10 @@ export interface components { /** @description The URL where this list can be accessed. */ url: string; }; - /** @description The most recent invoice this subscription has generated. */ + /** + * @nullable + * @description The most recent invoice this subscription has generated. + */ latest_invoice?: (string | components["schemas"]["invoice"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -24513,8 +29313,9 @@ export interface components { [key: string]: string; }; /** - * Format: unix-time + * @nullable * @description Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. + * @format unix-time */ next_pending_invoice_item_invoice?: number | null; /** @@ -24522,23 +29323,44 @@ export interface components { * @enum {string} */ object: "subscription"; - /** @description The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. */ + /** + * @nullable + * @description The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). */ + /** + * @nullable + * @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). + */ pause_collection?: components["schemas"]["subscriptions_resource_pause_collection"] | null; - /** @description Payment settings passed on to invoices created by the subscription. */ + /** + * @nullable + * @description Payment settings passed on to invoices created by the subscription. + */ payment_settings?: components["schemas"]["subscriptions_resource_payment_settings"] | null; - /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. */ + /** + * @nullable + * @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. + */ pending_invoice_item_interval?: components["schemas"]["subscription_pending_invoice_item_interval"] | null; - /** @description You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). */ + /** + * @nullable + * @description You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). + */ pending_setup_intent?: (string | components["schemas"]["setup_intent"]) | null; - /** @description If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. */ + /** + * @nullable + * @description If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. + */ pending_update?: components["schemas"]["subscriptions_resource_pending_update"] | null; - /** @description The schedule attached to the subscription */ + /** + * @nullable + * @description The schedule attached to the subscription + */ schedule?: (string | components["schemas"]["subscription_schedule"]) | null; /** - * Format: unix-time * @description Date when the subscription was first created. The date might differ from the `created` date due to backdating. + * @format unix-time */ start_date: number; /** @@ -24556,45 +29378,67 @@ export interface components { * @enum {string} */ status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid"; - /** @description ID of the test clock this subscription belongs to. */ + /** + * @nullable + * @description ID of the test clock this subscription belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; - /** @description The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ + /** + * @nullable + * @description The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. + */ transfer_data?: components["schemas"]["subscription_transfer_data"] | null; /** - * Format: unix-time + * @nullable * @description If the subscription has a trial, the end of that trial. + * @format unix-time */ trial_end?: number | null; - /** @description Settings related to subscription trials. */ + /** + * @nullable + * @description Settings related to subscription trials. + */ trial_settings?: components["schemas"]["subscriptions_trials_resource_trial_settings"] | null; /** - * Format: unix-time + * @nullable * @description If the subscription has a trial, the beginning of that trial. + * @format unix-time */ trial_start?: number | null; }; /** SubscriptionAutomaticTax */ subscription_automatic_tax: { /** + * @nullable * @description If Stripe disabled automatic tax, this enum describes why. * @enum {string|null} */ disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on this subscription. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; }; /** SubscriptionBillingThresholds */ subscription_billing_thresholds: { - /** @description Monetary threshold that triggers the subscription to create an invoice */ + /** + * @nullable + * @description Monetary threshold that triggers the subscription to create an invoice + */ amount_gte?: number | null; - /** @description Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. */ + /** + * @nullable + * @description Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. + */ reset_billing_cycle_anchor?: boolean | null; }; /** SubscriptionDetailsData */ subscription_details_data: { /** + * @nullable * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. * *Note: This attribute is populated only for invoices created on or after June 29, 2023.* */ @@ -24608,7 +29452,10 @@ export interface components { * one plan, making it easy to represent complex billing relationships. */ subscription_item: { - /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_item_billing_thresholds"] | null; /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; @@ -24630,23 +29477,31 @@ export interface components { quantity?: number; /** @description The `subscription` this `subscription_item` belongs to. */ subscription: string; - /** @description The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. */ + /** + * @nullable + * @description The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. + */ tax_rates?: components["schemas"]["tax_rate"][] | null; }; /** SubscriptionItemBillingThresholds */ subscription_item_billing_thresholds: { - /** @description Usage threshold that triggers the subscription to create an invoice */ + /** + * @nullable + * @description Usage threshold that triggers the subscription to create an invoice + */ usage_gte?: number | null; }; /** subscription_payment_method_options_card */ subscription_payment_method_options_card: { mandate_options?: components["schemas"]["invoice_mandate_options_card"]; /** + * @nullable * @description Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. * @enum {string|null} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** + * @nullable * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ @@ -24669,24 +29524,32 @@ export interface components { * Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules) */ subscription_schedule: { - /** @description ID of the Connect Application that created the schedule. */ + /** + * @nullable + * @description ID of the Connect Application that created the schedule. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; /** - * Format: unix-time + * @nullable * @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. + * @format unix-time */ completed_at?: number | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. */ + /** + * @nullable + * @description Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. + */ current_phase?: components["schemas"]["subscription_schedule_current_phase"] | null; /** @description ID of the customer who owns the subscription schedule. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; @@ -24700,7 +29563,10 @@ export interface components { id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -24712,20 +29578,30 @@ export interface components { /** @description Configuration for the subscription schedule's phases. */ phases: components["schemas"]["subscription_schedule_phase_configuration"][]; /** - * Format: unix-time + * @nullable * @description Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. + * @format unix-time */ released_at?: number | null; - /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ + /** + * @nullable + * @description ID of the subscription once managed by the subscription schedule (if it is released). + */ released_subscription?: string | null; /** * @description The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). * @enum {string} */ status: "active" | "canceled" | "completed" | "not_started" | "released"; - /** @description ID of the subscription managed by the subscription schedule. */ + /** + * @nullable + * @description ID of the subscription managed by the subscription schedule. + */ subscription?: (string | components["schemas"]["subscription"]) | null; - /** @description ID of the test clock this subscription schedule belongs to. */ + /** + * @nullable + * @description ID of the test clock this subscription schedule belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; }; /** @@ -24737,9 +29613,15 @@ export interface components { discounts: components["schemas"]["discounts_resource_stackable_discount"][]; /** @description ID of the price used to generate the invoice item. */ price: string | components["schemas"]["price"] | components["schemas"]["deleted_price"]; - /** @description The quantity of the invoice item. */ + /** + * @nullable + * @description The quantity of the invoice item. + */ quantity?: number | null; - /** @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. */ + /** + * @nullable + * @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. + */ tax_rates?: components["schemas"]["tax_rate"][] | null; }; /** @@ -24747,11 +29629,17 @@ export interface components { * @description A phase item describes the price and quantity of a phase. */ subscription_schedule_configuration_item: { - /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_item_billing_thresholds"] | null; /** @description The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ discounts: components["schemas"]["discounts_resource_stackable_discount"][]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. + */ metadata?: { [key: string]: string; } | null; @@ -24759,19 +29647,22 @@ export interface components { price: string | components["schemas"]["price"] | components["schemas"]["deleted_price"]; /** @description Quantity of the plan to which the customer should be subscribed. */ quantity?: number; - /** @description The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`. */ + /** + * @nullable + * @description The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`. + */ tax_rates?: components["schemas"]["tax_rate"][] | null; }; /** SubscriptionScheduleCurrentPhase */ subscription_schedule_current_phase: { /** - * Format: unix-time * @description The end of this phase of the subscription schedule. + * @format unix-time */ end_date: number; /** - * Format: unix-time * @description The start of this phase of the subscription schedule. + * @format unix-time */ start_date: number; }; @@ -24782,50 +29673,79 @@ export interface components { subscription_schedule_phase_configuration: { /** @description A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. */ add_invoice_items: components["schemas"]["subscription_schedule_add_invoice_item"][]; - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. + */ application_fee_percent?: number | null; automatic_tax?: components["schemas"]["schedules_phase_automatic_tax"]; /** + * @nullable * @description Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string|null} */ billing_cycle_anchor?: "automatic" | "phase_start" | null; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_billing_thresholds"] | null; /** + * @nullable * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. * @enum {string|null} */ collection_method?: "charge_automatically" | "send_invoice" | null; - /** @description ID of the coupon to use during this phase of the subscription schedule. */ + /** + * @nullable + * @description ID of the coupon to use during this phase of the subscription schedule. + */ coupon?: (string | components["schemas"]["coupon"] | components["schemas"]["deleted_coupon"]) | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. */ + /** + * @nullable + * @description ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. + */ 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. */ + /** + * @nullable + * @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 for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @description Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. + */ description?: string | null; /** @description The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts. */ discounts: components["schemas"]["discounts_resource_stackable_discount"][]; /** - * Format: unix-time * @description The end of this phase of the subscription schedule. + * @format unix-time */ end_date: number; - /** @description The invoice settings applicable during this phase. */ + /** + * @nullable + * @description The invoice settings applicable during this phase. + */ invoice_settings?: components["schemas"]["invoice_setting_subscription_schedule_phase_setting"] | null; /** @description Subscription items to configure the subscription to during this phase of the subscription schedule. */ items: components["schemas"]["subscription_schedule_configuration_item"][]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. + */ metadata?: { [key: string]: string; } | null; - /** @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. */ + /** + * @nullable + * @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** * @description If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. @@ -24833,21 +29753,28 @@ export interface components { */ proration_behavior: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description The start of this phase of the subscription schedule. + * @format unix-time */ start_date: number; - /** @description The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ + /** + * @nullable + * @description The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. + */ transfer_data?: components["schemas"]["subscription_transfer_data"] | null; /** - * Format: unix-time + * @nullable * @description When the trial ends within the phase. + * @format unix-time */ trial_end?: number | null; }; /** SubscriptionSchedulesResourceDefaultSettings */ subscription_schedules_resource_default_settings: { - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. + */ application_fee_percent?: number | null; automatic_tax?: components["schemas"]["subscription_schedules_resource_default_settings_automatic_tax"]; /** @@ -24855,38 +29782,61 @@ export interface components { * @enum {string} */ billing_cycle_anchor: "automatic" | "phase_start"; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_billing_thresholds"] | null; /** + * @nullable * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. * @enum {string|null} */ collection_method?: "charge_automatically" | "send_invoice" | null; - /** @description ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. */ + /** + * @nullable + * @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 for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @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; invoice_settings: components["schemas"]["invoice_setting_subscription_schedule_setting"]; - /** @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. */ + /** + * @nullable + * @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ + /** + * @nullable + * @description The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. + */ transfer_data?: components["schemas"]["subscription_transfer_data"] | null; }; /** SubscriptionSchedulesResourceDefaultSettingsAutomaticTax */ subscription_schedules_resource_default_settings_automatic_tax: { /** + * @nullable * @description If Stripe disabled automatic tax, this enum describes why. * @enum {string|null} */ disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; }; /** SubscriptionTransferData */ subscription_transfer_data: { - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + */ amount_percent?: number | null; /** @description The account where funds from the payment will be transferred to upon payment success. */ destination: string | components["schemas"]["account"]; @@ -24895,13 +29845,25 @@ export interface components { subscriptions_resource_billing_cycle_anchor_config: { /** @description The day of the month of the billing_cycle_anchor. */ day_of_month: number; - /** @description The hour of the day of the billing_cycle_anchor. */ + /** + * @nullable + * @description The hour of the day of the billing_cycle_anchor. + */ hour?: number | null; - /** @description The minute of the hour of the billing_cycle_anchor. */ + /** + * @nullable + * @description The minute of the hour of the billing_cycle_anchor. + */ minute?: number | null; - /** @description The month to start full cycle billing periods. */ + /** + * @nullable + * @description The month to start full cycle billing periods. + */ month?: number | null; - /** @description The second of the minute of the billing_cycle_anchor. */ + /** + * @nullable + * @description The second of the minute of the billing_cycle_anchor. + */ second?: number | null; }; /** @@ -24916,35 +29878,64 @@ export interface components { */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; /** - * Format: unix-time + * @nullable * @description The time after which the subscription will resume collecting payments. + * @format unix-time */ resumes_at?: number | null; }; /** SubscriptionsResourcePaymentMethodOptions */ subscriptions_resource_payment_method_options: { - /** @description This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. + */ acss_debit?: components["schemas"]["invoice_payment_method_options_acss_debit"] | null; - /** @description This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. + */ bancontact?: components["schemas"]["invoice_payment_method_options_bancontact"] | null; - /** @description This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. + */ card?: components["schemas"]["subscription_payment_method_options_card"] | null; - /** @description This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription. + */ customer_balance?: components["schemas"]["invoice_payment_method_options_customer_balance"] | null; - /** @description This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. + */ konbini?: components["schemas"]["invoice_payment_method_options_konbini"] | null; - /** @description This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription. + */ sepa_debit?: components["schemas"]["invoice_payment_method_options_sepa_debit"] | null; - /** @description This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription. + */ us_bank_account?: components["schemas"]["invoice_payment_method_options_us_bank_account"] | null; }; /** SubscriptionsResourcePaymentSettings */ subscriptions_resource_payment_settings: { - /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ + /** + * @nullable + * @description Payment-method-specific configuration to provide to invoices created by the subscription. + */ payment_method_options?: components["schemas"]["subscriptions_resource_payment_method_options"] | null; - /** @description The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ + /** + * @nullable + * @description The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). + */ payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; /** + * @nullable * @description Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`. * @enum {string|null} */ @@ -24957,28 +29948,39 @@ export interface components { */ subscriptions_resource_pending_update: { /** - * Format: unix-time + * @nullable * @description If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. + * @format unix-time */ billing_cycle_anchor?: number | null; /** - * Format: unix-time * @description The point after which the changes reflected by this update will be discarded and no longer applied. + * @format unix-time */ expires_at: number; - /** @description List of subscription items, each with an attached plan, that will be set if the update is applied. */ + /** + * @nullable + * @description List of subscription items, each with an attached plan, that will be set if the update is applied. + */ subscription_items?: components["schemas"]["subscription_item"][] | null; /** - * Format: unix-time + * @nullable * @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. + * @format unix-time */ trial_end?: number | null; - /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** + * @nullable + * @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. + */ trial_from_plan?: boolean | null; }; /** SubscriptionsResourceSubscriptionInvoiceSettings */ subscriptions_resource_subscription_invoice_settings: { - /** @description The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription. */ + /** + * @nullable + * @description The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; issuer: components["schemas"]["connect_account_reference"]; }; @@ -25011,18 +30013,26 @@ export interface components { amount_total: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; - /** @description The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. */ + /** + * @nullable + * @description The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. + */ customer?: string | null; customer_details: components["schemas"]["tax_product_resource_customer_details"]; /** - * Format: unix-time + * @nullable * @description Timestamp of date at which the tax calculation will expire. + * @format unix-time */ expires_at?: number | null; - /** @description Unique identifier for the calculation. */ + /** + * @nullable + * @description Unique identifier for the calculation. + */ id?: string | null; /** * TaxProductResourceTaxCalculationLineItemList + * @nullable * @description The list of items the customer is purchasing. */ line_items?: { @@ -25035,7 +30045,10 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/calculations/[^/]+/line_items + */ url: string; } | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -25045,9 +30058,15 @@ export interface components { * @enum {string} */ object: "tax.calculation"; - /** @description The details of the ship from location, such as the address. */ + /** + * @nullable + * @description The details of the ship from location, such as the address. + */ ship_from_details?: components["schemas"]["tax_product_resource_ship_from_details"] | null; - /** @description The shipping cost details for the calculation. */ + /** + * @nullable + * @description The shipping cost details for the calculation. + */ shipping_cost?: components["schemas"]["tax_product_resource_tax_calculation_shipping_cost"] | null; /** @description The amount of tax to be collected on top of the line item prices. */ tax_amount_exclusive: number; @@ -25056,8 +30075,8 @@ export interface components { /** @description Breakdown of individual tax amounts that add up to the total. */ tax_breakdown: components["schemas"]["tax_product_resource_tax_breakdown"][]; /** - * Format: unix-time * @description Timestamp of date at which the tax rules and rates in effect applies for the calculation. + * @format unix-time */ tax_date: number; }; @@ -25076,18 +30095,27 @@ export interface components { * @enum {string} */ object: "tax.calculation_line_item"; - /** @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). */ + /** + * @nullable + * @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). + */ product?: string | null; /** @description The number of units of the item being purchased. For reversals, this is the quantity reversed. */ quantity: number; - /** @description A custom identifier for this line item. */ + /** + * @nullable + * @description A custom identifier for this line item. + */ reference?: string | null; /** * @description Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. * @enum {string} */ tax_behavior: "exclusive" | "inclusive"; - /** @description Detailed account of taxes relevant to this line item. */ + /** + * @nullable + * @description Detailed account of taxes relevant to this line item. + */ tax_breakdown?: components["schemas"]["tax_product_resource_line_item_tax_breakdown"][] | null; /** @description The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. */ tax_code: string; @@ -25102,21 +30130,22 @@ export interface components { */ "tax.registration": { /** - * Format: unix-time * @description Time at which the registration becomes active. Measured in seconds since the Unix epoch. + * @format unix-time */ 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. + * @format unix-time */ created: number; /** - * Format: unix-time + * @nullable * @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 */ expires_at?: number | null; /** @description Unique identifier for the object. */ @@ -25142,7 +30171,10 @@ export interface components { */ "tax.settings": { defaults: components["schemas"]["tax_product_resource_tax_settings_defaults"]; - /** @description The place where your business is located. */ + /** + * @nullable + * @description The place where your business is located. + */ head_office?: components["schemas"]["tax_product_resource_tax_settings_head_office"] | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -25166,19 +30198,23 @@ export interface components { */ "tax.transaction": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; - /** @description The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. */ + /** + * @nullable + * @description The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. + */ customer?: string | null; customer_details: components["schemas"]["tax_product_resource_customer_details"]; /** @description Unique identifier for the transaction. */ id: string; /** * TaxProductResourceTaxTransactionLineItemList + * @nullable * @description The tax collected or refunded, by line item. */ line_items?: { @@ -25191,12 +30227,18 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/transactions/[^/]+/line_items + */ url: string; } | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -25206,21 +30248,30 @@ export interface components { */ object: "tax.transaction"; /** - * Format: unix-time * @description The Unix timestamp representing when the tax liability is assumed or reduced. + * @format unix-time */ posted_at: number; /** @description A custom unique identifier, such as 'myOrder_123'. */ reference: string; - /** @description If `type=reversal`, contains information about what was reversed. */ + /** + * @nullable + * @description If `type=reversal`, contains information about what was reversed. + */ reversal?: components["schemas"]["tax_product_resource_tax_transaction_resource_reversal"] | null; - /** @description The details of the ship from location, such as the address. */ + /** + * @nullable + * @description The details of the ship from location, such as the address. + */ ship_from_details?: components["schemas"]["tax_product_resource_ship_from_details"] | null; - /** @description The shipping cost details for the transaction. */ + /** + * @nullable + * @description The shipping cost details for the transaction. + */ shipping_cost?: components["schemas"]["tax_product_resource_tax_transaction_shipping_cost"] | null; /** - * Format: unix-time * @description Timestamp of date at which the tax rules and rates in effect applies for the calculation. + * @format unix-time */ tax_date: number; /** @@ -25239,7 +30290,10 @@ export interface components { id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -25248,13 +30302,19 @@ export interface components { * @enum {string} */ object: "tax.transaction_line_item"; - /** @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). */ + /** + * @nullable + * @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). + */ product?: string | null; /** @description The number of units of the item being purchased. For reversals, this is the quantity reversed. */ quantity: number; /** @description A custom identifier for this line item in the transaction. */ reference: string; - /** @description If `type=reversal`, contains information about what was reversed. */ + /** + * @nullable + * @description If `type=reversal`, contains information about what was reversed. + */ reversal?: components["schemas"]["tax_product_resource_tax_transaction_line_item_resource_reversal"] | null; /** * @description Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. @@ -25296,13 +30356,13 @@ export interface components { */ object: "tax_deducted_at_source"; /** - * Format: unix-time * @description The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. + * @format unix-time */ period_end: number; /** - * Format: unix-time * @description The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. + * @format unix-time */ period_start: number; /** @description The TAN that was supplied to Stripe when TDS was assessed */ @@ -25330,14 +30390,20 @@ export interface components { * Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids) */ tax_id: { - /** @description Two-letter ISO code representing the country of the tax ID. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the tax ID. + */ country?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description ID of the customer. */ + /** + * @nullable + * @description ID of the customer. + */ customer?: (string | components["schemas"]["customer"]) | null; /** @description Unique identifier for the object. */ id: string; @@ -25348,7 +30414,10 @@ export interface components { * @enum {string} */ object: "tax_id"; - /** @description The account or customer the tax ID belongs to. */ + /** + * @nullable + * @description The account or customer the tax ID belongs to. + */ owner?: components["schemas"]["tax_i_ds_owner"] | null; /** * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` @@ -25357,7 +30426,10 @@ export interface components { type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; - /** @description Tax ID verification information. */ + /** + * @nullable + * @description Tax ID verification information. + */ verification?: components["schemas"]["tax_id_verification"] | null; }; /** tax_id_verification */ @@ -25367,9 +30439,15 @@ export interface components { * @enum {string} */ status: "pending" | "unavailable" | "unverified" | "verified"; - /** @description Verified address. */ + /** + * @nullable + * @description Verified address. + */ verified_address?: string | null; - /** @description Verified name. */ + /** + * @nullable + * @description Verified name. + */ verified_name?: string | null; }; /** TaxProductRegistrationsResourceCountryOptions */ @@ -25548,14 +30626,21 @@ export interface components { }; /** TaxProductResourceCustomerDetails */ tax_product_resource_customer_details: { - /** @description The customer's postal address (for example, home or business location). */ + /** + * @nullable + * @description The customer's postal address (for example, home or business location). + */ address?: components["schemas"]["tax_product_resource_postal_address"] | null; /** + * @nullable * @description The type of customer address provided. * @enum {string|null} */ address_source?: "billing" | "shipping" | null; - /** @description The customer's IP address (IPv4 or IPv6). */ + /** + * @nullable + * @description The customer's IP address (IPv4 or IPv6). + */ ip_address?: string | null; /** @description The customer's tax IDs (for example, EU VAT numbers). */ tax_ids: components["schemas"]["tax_product_resource_customer_details_resource_tax_id"][]; @@ -25586,7 +30671,10 @@ export interface components { * @enum {string} */ level: "city" | "country" | "county" | "district" | "state"; - /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ + /** + * @nullable + * @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. + */ state?: string | null; }; /** TaxProductResourceLineItemTaxBreakdown */ @@ -25599,7 +30687,10 @@ export interface components { * @enum {string} */ sourcing: "destination" | "origin"; - /** @description Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax. */ + /** + * @nullable + * @description Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax. + */ tax_rate_details?: components["schemas"]["tax_product_resource_line_item_tax_rate_details"] | null; /** * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. @@ -25623,17 +30714,32 @@ export interface components { }; /** TaxProductResourcePostalAddress */ tax_product_resource_postal_address: { - /** @description City, district, suburb, town, or village. */ + /** + * @nullable + * @description City, district, suburb, town, or village. + */ city?: string | null; /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ country: string; - /** @description Address line 1 (e.g., street, PO Box, or company name). */ + /** + * @nullable + * @description Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string | null; - /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + /** + * @nullable + * @description Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ postal_code?: string | null; - /** @description State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". */ + /** + * @nullable + * @description State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". + */ state?: string | null; }; /** TaxProductResourceShipFromDetails */ @@ -25675,20 +30781,31 @@ export interface components { }; /** TaxProductResourceTaxRateDetails */ tax_product_resource_tax_rate_details: { - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; - /** @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. */ + /** + * @nullable + * @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. + */ flat_amount?: components["schemas"]["tax_rate_flat_amount"] | null; /** @description The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`. */ percentage_decimal: string; /** + * @nullable * @description Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. * @enum {string|null} */ rate_type?: "flat_amount" | "percentage" | null; - /** @description State, county, province, or region. */ + /** + * @nullable + * @description State, county, province, or region. + */ state?: string | null; /** + * @nullable * @description The tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ @@ -25697,11 +30814,15 @@ export interface components { /** TaxProductResourceTaxSettingsDefaults */ tax_product_resource_tax_settings_defaults: { /** + * @nullable * @description Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior. * @enum {string|null} */ tax_behavior?: "exclusive" | "inclusive" | "inferred_by_currency" | null; - /** @description Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices. */ + /** + * @nullable + * @description Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices. + */ tax_code?: string | null; }; /** TaxProductResourceTaxSettingsHeadOffice */ @@ -25717,7 +30838,10 @@ export interface components { tax_product_resource_tax_settings_status_details_resource_active: Record; /** TaxProductResourceTaxSettingsStatusDetailsResourcePending */ tax_product_resource_tax_settings_status_details_resource_pending: { - /** @description The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call. */ + /** + * @nullable + * @description The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call. + */ missing_fields?: string[] | null; }; /** TaxProductResourceTaxTransactionLineItemResourceReversal */ @@ -25727,7 +30851,10 @@ export interface components { }; /** TaxProductResourceTaxTransactionResourceReversal */ tax_product_resource_tax_transaction_resource_reversal: { - /** @description The `id` of the reversed `Transaction` object. */ + /** + * @nullable + * @description The `id` of the reversed `Transaction` object. + */ original_transaction?: string | null; }; /** TaxProductResourceTaxTransactionShippingCost */ @@ -25755,39 +30882,56 @@ export interface components { tax_rate: { /** @description Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ active: boolean; - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ + /** + * @nullable + * @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. + */ description?: string | null; /** @description The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. */ display_name: string; /** + * @nullable * @description Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, * this percentage reflects the rate actually used to calculate tax based on the product's taxability * and whether the user is registered to collect taxes in the corresponding jurisdiction. */ effective_percentage?: number | null; - /** @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. */ + /** + * @nullable + * @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. + */ flat_amount?: components["schemas"]["tax_rate_flat_amount"] | null; /** @description Unique identifier for the object. */ id: string; /** @description This specifies if the tax rate is inclusive or exclusive. */ inclusive: boolean; - /** @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. */ + /** + * @nullable + * @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. + */ jurisdiction?: string | null; /** + * @nullable * @description The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. * @enum {string|null} */ jurisdiction_level?: "city" | "country" | "county" | "district" | "multiple" | "state" | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -25799,13 +30943,18 @@ export interface components { /** @description Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. */ percentage: number; /** + * @nullable * @description Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. * @enum {string|null} */ rate_type?: "flat_amount" | "percentage" | null; - /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ + /** + * @nullable + * @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. + */ state?: string | null; /** + * @nullable * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ @@ -25829,11 +30978,17 @@ export interface components { bbpos_wisepos_e?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; /** @description Unique identifier for the object. */ id: string; - /** @description Whether this Configuration is the default for your account */ + /** + * @nullable + * @description Whether this Configuration is the default for your account + */ is_account_default?: boolean | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description String indicating the name of the Configuration object, set by the user */ + /** + * @nullable + * @description String indicating the name of the Configuration object, set by the user + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -25896,9 +31051,15 @@ export interface components { * Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader) */ "terminal.reader": { - /** @description The most recent action performed by the reader. */ + /** + * @nullable + * @description The most recent action performed by the reader. + */ action?: components["schemas"]["terminal_reader_reader_resource_reader_action"] | null; - /** @description The current software version of the reader. */ + /** + * @nullable + * @description The current software version of the reader. + */ device_sw_version?: string | null; /** * @description Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. @@ -25907,13 +31068,19 @@ export interface components { device_type: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700" | "verifone_P400"; /** @description Unique identifier for the object. */ id: string; - /** @description The local IP address of the reader. */ + /** + * @nullable + * @description The local IP address of the reader. + */ ip_address?: string | null; /** @description Custom label given to the reader for easier identification. */ label: 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 location identifier of the reader. */ + /** + * @nullable + * @description The location identifier of the reader. + */ location?: (string | components["schemas"]["terminal.location"]) | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { @@ -25927,6 +31094,7 @@ export interface components { /** @description Serial number of the reader. */ serial_number: string; /** + * @nullable * @description The networking status of the reader. We do not recommend using this field in flows that may block taking payments. * @enum {string|null} */ @@ -25934,9 +31102,15 @@ export interface components { }; /** TerminalConfigurationConfigurationResourceCurrencySpecificConfig */ terminal_configuration_configuration_resource_currency_specific_config: { - /** @description Fixed amounts displayed when collecting a tip */ + /** + * @nullable + * @description Fixed amounts displayed when collecting a tip + */ fixed_amounts?: number[] | null; - /** @description Percentages displayed when collecting a tip */ + /** + * @nullable + * @description Percentages displayed when collecting a tip + */ percentages?: number[] | null; /** @description Below this amount, fixed amounts will be displayed; above it, percentages will be displayed */ smart_tip_threshold?: number; @@ -25948,7 +31122,10 @@ export interface components { }; /** TerminalConfigurationConfigurationResourceOfflineConfig */ terminal_configuration_configuration_resource_offline_config: { - /** @description Determines whether to allow transactions to be collected while reader is offline. Defaults to false. */ + /** + * @nullable + * @description Determines whether to allow transactions to be collected while reader is offline. Defaults to false. + */ enabled?: boolean | null; }; /** TerminalConfigurationConfigurationResourceRebootWindow */ @@ -25983,13 +31160,16 @@ export interface components { */ terminal_reader_reader_resource_cart: { /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description List of line items in the cart. */ line_items: components["schemas"]["terminal_reader_reader_resource_line_item"][]; - /** @description Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** + * @nullable + * @description Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + */ tax?: number | null; /** @description Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ total: number; @@ -26050,9 +31230,15 @@ export interface components { * @description Represents an action performed by the reader */ terminal_reader_reader_resource_reader_action: { - /** @description Failure code, only set if status is `failed`. */ + /** + * @nullable + * @description Failure code, only set if status is `failed`. + */ failure_code?: string | null; - /** @description Detailed failure message, only set if status is `failed`. */ + /** + * @nullable + * @description Detailed failure message, only set if status is `failed`. + */ failure_message?: string | null; process_payment_intent?: components["schemas"]["terminal_reader_reader_resource_process_payment_intent_action"]; process_setup_intent?: components["schemas"]["terminal_reader_reader_resource_process_setup_intent_action"]; @@ -26110,7 +31296,10 @@ export interface components { * @description Represents a reader action to set the reader display */ terminal_reader_reader_resource_set_reader_display_action: { - /** @description Cart object to be displayed by the reader. */ + /** + * @nullable + * @description Cart object to be displayed by the reader. + */ cart?: components["schemas"]["terminal_reader_reader_resource_cart"] | null; /** * @description Type of information to be displayed by the reader. @@ -26134,25 +31323,28 @@ export interface components { */ "test_helpers.test_clock": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time * @description Time at which this clock is scheduled to auto delete. + * @format unix-time */ deletes_after: number; /** - * Format: unix-time * @description Time at which all objects belonging to this clock are frozen. + * @format unix-time */ frozen_time: number; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description The custom name supplied at creation. */ + /** + * @nullable + * @description The custom name supplied at creation. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -26169,34 +31361,40 @@ export interface components { /** three_d_secure_details */ three_d_secure_details: { /** + * @nullable * @description For authenticated transactions: how the customer was authenticated by * the issuing bank. * @enum {string|null} */ authentication_flow?: "challenge" | "frictionless" | null; /** + * @nullable * @description The Electronic Commerce Indicator (ECI). A protocol-level field * indicating what degree of authentication was performed. * @enum {string|null} */ electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07" | null; /** + * @nullable * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} */ result?: "attempt_acknowledged" | "authenticated" | "exempted" | "failed" | "not_supported" | "processing_error" | null; /** + * @nullable * @description Additional information about why 3D Secure succeeded or failed based * on the `result`. * @enum {string|null} */ result_reason?: "abandoned" | "bypassed" | "canceled" | "card_not_enrolled" | "network_not_supported" | "protocol_error" | "rejected" | null; /** + * @nullable * @description The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID * (dsTransId) for this payment. */ transaction_id?: string | null; /** + * @nullable * @description The version of 3D Secure that was used. * @enum {string|null} */ @@ -26205,18 +31403,21 @@ export interface components { /** three_d_secure_details_charge */ three_d_secure_details_charge: { /** + * @nullable * @description For authenticated transactions: how the customer was authenticated by * the issuing bank. * @enum {string|null} */ authentication_flow?: "challenge" | "frictionless" | null; /** + * @nullable * @description The Electronic Commerce Indicator (ECI). A protocol-level field * indicating what degree of authentication was performed. * @enum {string|null} */ electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07" | null; /** + * @nullable * @description The exemption requested via 3DS and accepted by the issuer at authentication time. * @enum {string|null} */ @@ -26227,22 +31428,26 @@ export interface components { */ exemption_indicator_applied?: boolean; /** + * @nullable * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} */ result?: "attempt_acknowledged" | "authenticated" | "exempted" | "failed" | "not_supported" | "processing_error" | null; /** + * @nullable * @description Additional information about why 3D Secure succeeded or failed based * on the `result`. * @enum {string|null} */ result_reason?: "abandoned" | "bypassed" | "canceled" | "card_not_enrolled" | "network_not_supported" | "protocol_error" | "rejected" | null; /** + * @nullable * @description The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID * (dsTransId) for this payment. */ transaction_id?: string | null; /** + * @nullable * @description The version of 3D Secure that was used. * @enum {string|null} */ @@ -26255,7 +31460,10 @@ export interface components { }; /** ThresholdsResourceUsageAlertFilter */ thresholds_resource_usage_alert_filter: { - /** @description Limit the scope of the alert to this customer ID */ + /** + * @nullable + * @description Limit the scope of the alert to this customer ID + */ customer?: (string | components["schemas"]["customer"]) | null; /** @enum {string} */ type: "customer"; @@ -26265,7 +31473,10 @@ export interface components { * @description The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed. */ thresholds_resource_usage_threshold_config: { - /** @description The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time. */ + /** + * @nullable + * @description The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time. + */ filters?: components["schemas"]["thresholds_resource_usage_alert_filter"][] | null; /** @description The value at which this alert will trigger. */ gte: number; @@ -26303,11 +31514,14 @@ export interface components { token: { bank_account?: components["schemas"]["bank_account"]; card?: components["schemas"]["card"]; - /** @description IP address of the client that generates the token. */ + /** + * @nullable + * @description IP address of the client that generates the token. + */ client_ip?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ @@ -26326,7 +31540,10 @@ export interface components { }; /** token_card_networks */ token_card_networks: { - /** @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. */ + /** + * @nullable + * @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. + */ preferred?: string | null; }; /** @@ -26340,22 +31557,37 @@ export interface components { topup: { /** @description Amount transferred. */ amount: number; - /** @description ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. */ + /** + * @nullable + * @description ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. */ + /** + * @nullable + * @description Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. + */ expected_availability_date?: number | null; - /** @description Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ + /** + * @nullable + * @description Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). + */ failure_code?: string | null; - /** @description Message to user further explaining reason for top-up failure if available. */ + /** + * @nullable + * @description Message to user further explaining reason for top-up failure if available. + */ failure_message?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26370,16 +31602,25 @@ export interface components { * @enum {string} */ object: "topup"; - /** @description The source field is deprecated. It might not always be present in the API response. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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; /** * @description The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. * @enum {string} */ status: "canceled" | "failed" | "pending" | "reversed" | "succeeded"; - /** @description A string that identifies this top-up as part of a group. */ + /** + * @nullable + * @description A string that identifies this top-up as part of a group. + */ transfer_group?: string | null; }; /** @@ -26400,21 +31641,30 @@ export interface components { amount: number; /** @description Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ amount_reversed: number; - /** @description Balance transaction that describes the impact of this transfer on your account balance. */ + /** + * @nullable + * @description Balance transaction that describes the impact of this transfer on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time that this record of the transfer was first created. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description ID of the Stripe account the transfer was sent to. */ + /** + * @nullable + * @description ID of the Stripe account the transfer was sent to. + */ destination?: (string | components["schemas"]["account"]) | null; /** @description If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. */ destination_payment?: string | components["schemas"]["charge"]; @@ -26450,11 +31700,17 @@ export interface components { }; /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ reversed: boolean; - /** @description ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance. */ + /** + * @nullable + * @description ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance. + */ source_transaction?: (string | components["schemas"]["charge"]) | null; /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ source_type?: string; - /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /** + * @nullable + * @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. + */ transfer_group?: string | null; }; /** transfer_data */ @@ -26487,23 +31743,32 @@ export interface components { transfer_reversal: { /** @description Amount, in cents (or local equivalent). */ amount: number; - /** @description Balance transaction that describes the impact on your account balance. */ + /** + * @nullable + * @description Balance transaction that describes the impact on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description Linked payment refund for the transfer reversal. */ + /** + * @nullable + * @description Linked payment refund for the transfer reversal. + */ destination_payment_refund?: (string | components["schemas"]["refund"]) | null; /** @description Unique identifier for the object. */ id: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -26512,7 +31777,10 @@ export interface components { * @enum {string} */ object: "transfer_reversal"; - /** @description ID of the refund responsible for the transfer reversal. */ + /** + * @nullable + * @description ID of the refund responsible for the transfer reversal. + */ source_refund?: (string | components["schemas"]["refund"]) | null; /** @description ID of the transfer that was reversed. */ transfer: string | components["schemas"]["transfer"]; @@ -26556,18 +31824,21 @@ export interface components { /** @description Amount (in cents) transferred. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The FinancialAccount to reverse funds from. */ financial_account: string; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26595,7 +31866,10 @@ export interface components { */ status: "canceled" | "posted" | "processing"; status_transitions: components["schemas"]["treasury_received_credits_resource_status_transitions"]; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -26606,22 +31880,31 @@ export interface components { /** @description Amount (in cents) transferred. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description The FinancialAccount to reverse funds from. */ + /** + * @nullable + * @description The FinancialAccount to reverse funds from. + */ financial_account?: string | null; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; - /** @description Other flows linked to a DebitReversal. */ + /** + * @nullable + * @description Other flows linked to a DebitReversal. + */ linked_flows?: components["schemas"]["treasury_received_debits_resource_debit_reversal_linked_flows"] | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -26647,7 +31930,10 @@ export interface components { */ status: "failed" | "processing" | "succeeded"; status_transitions: components["schemas"]["treasury_received_debits_resource_status_transitions"]; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -26662,8 +31948,8 @@ export interface components { /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ country: string; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; features?: components["schemas"]["treasury.financial_account_features"]; @@ -26674,11 +31960,17 @@ export interface components { is_default?: boolean; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description The nickname for the FinancialAccount. */ + /** + * @nullable + * @description The nickname for the FinancialAccount. + */ nickname?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -26687,7 +31979,10 @@ export interface components { object: "treasury.financial_account"; /** @description The array of paths to pending Features in the Features hash. */ pending_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; - /** @description The set of functionalities that the platform can restrict on the FinancialAccount. */ + /** + * @nullable + * @description The set of functionalities that the platform can restrict on the FinancialAccount. + */ platform_restrictions?: components["schemas"]["treasury_financial_accounts_resource_platform_restrictions"] | null; /** @description The array of paths to restricted Features in the Features hash. */ restricted_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; @@ -26731,22 +32026,31 @@ export interface components { /** @description Returns `true` if the InboundTransfer is able to be canceled. */ cancelable: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Details about this InboundTransfer's failure. Only set when status is `failed`. */ + /** + * @nullable + * @description Details about this InboundTransfer's failure. Only set when status is `failed`. + */ failure_details?: components["schemas"]["treasury_inbound_transfers_resource_failure_details"] | null; /** @description The FinancialAccount that received the funds. */ financial_account: string; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26762,11 +32066,20 @@ export interface components { * @enum {string} */ object: "treasury.inbound_transfer"; - /** @description The origin payment method to be debited for an InboundTransfer. */ + /** + * @nullable + * @description The origin payment method to be debited for an InboundTransfer. + */ origin_payment_method?: string | null; - /** @description Details about the PaymentMethod for an InboundTransfer. */ + /** + * @nullable + * @description Details about the PaymentMethod for an InboundTransfer. + */ origin_payment_method_details?: components["schemas"]["inbound_transfers"] | null; - /** @description Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state. */ + /** + * @nullable + * @description Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state. + */ returned?: boolean | null; /** @description Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`. */ statement_descriptor: string; @@ -26776,7 +32089,10 @@ export interface components { */ status: "canceled" | "failed" | "processing" | "succeeded"; status_transitions: components["schemas"]["treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions"]; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -26793,33 +32109,51 @@ export interface components { /** @description Returns `true` if the object can be canceled, and `false` otherwise. */ cancelable: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. */ + /** + * @nullable + * @description ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. + */ customer?: string | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`. */ + /** + * @nullable + * @description The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`. + */ destination_payment_method?: string | null; - /** @description Details about the PaymentMethod for an OutboundPayment. */ + /** + * @nullable + * @description Details about the PaymentMethod for an OutboundPayment. + */ destination_payment_method_details?: components["schemas"]["outbound_payments_payment_method_details"] | null; - /** @description Details about the end user. */ + /** + * @nullable + * @description Details about the end user. + */ end_user_details?: components["schemas"]["treasury_outbound_payments_resource_outbound_payment_resource_end_user_details"] | null; /** - * Format: unix-time * @description The date when funds are expected to arrive in the destination account. + * @format unix-time */ expected_arrival_date: number; /** @description The FinancialAccount that funds were pulled from. */ financial_account: string; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26834,7 +32168,10 @@ export interface components { * @enum {string} */ object: "treasury.outbound_payment"; - /** @description Details about a returned OutboundPayment. Only set when the status is `returned`. */ + /** + * @nullable + * @description Details about a returned OutboundPayment. Only set when the status is `returned`. + */ returned_details?: components["schemas"]["treasury_outbound_payments_resource_returned_status"] | null; /** @description The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). */ statement_descriptor: string; @@ -26844,7 +32181,10 @@ export interface components { */ status: "canceled" | "failed" | "posted" | "processing" | "returned"; status_transitions: components["schemas"]["treasury_outbound_payments_resource_outbound_payment_resource_status_transitions"]; - /** @description Details about network-specific tracking information if available. */ + /** + * @nullable + * @description Details about network-specific tracking information if available. + */ tracking_details?: components["schemas"]["treasury_outbound_payments_resource_outbound_payment_resource_tracking_details"] | null; /** @description The Transaction associated with this object. */ transaction: string | components["schemas"]["treasury.transaction"]; @@ -26863,28 +32203,37 @@ export interface components { /** @description Returns `true` if the object can be canceled, and `false` otherwise. */ cancelable: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description The PaymentMethod used as the payment instrument for an OutboundTransfer. */ + /** + * @nullable + * @description The PaymentMethod used as the payment instrument for an OutboundTransfer. + */ destination_payment_method?: string | null; destination_payment_method_details: components["schemas"]["outbound_transfers_payment_method_details"]; /** - * Format: unix-time * @description The date when funds are expected to arrive in the destination account. + * @format unix-time */ expected_arrival_date: number; /** @description The FinancialAccount that funds were pulled from. */ financial_account: string; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26899,7 +32248,10 @@ export interface components { * @enum {string} */ object: "treasury.outbound_transfer"; - /** @description Details about a returned OutboundTransfer. Only set when the status is `returned`. */ + /** + * @nullable + * @description Details about a returned OutboundTransfer. Only set when the status is `returned`. + */ returned_details?: components["schemas"]["treasury_outbound_transfers_resource_returned_details"] | null; /** @description Information about the OutboundTransfer to be sent to the recipient account. */ statement_descriptor: string; @@ -26909,7 +32261,10 @@ export interface components { */ status: "canceled" | "failed" | "posted" | "processing" | "returned"; status_transitions: components["schemas"]["treasury_outbound_transfers_resource_status_transitions"]; - /** @description Details about network-specific tracking information if available. */ + /** + * @nullable + * @description Details about network-specific tracking information if available. + */ tracking_details?: components["schemas"]["treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details"] | null; /** @description The Transaction associated with this object. */ transaction: string | components["schemas"]["treasury.transaction"]; @@ -26922,25 +32277,32 @@ export interface components { /** @description Amount (in cents) transferred. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; /** + * @nullable * @description Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. * @enum {string|null} */ failure_code?: "account_closed" | "account_frozen" | "international_transaction" | "other" | null; - /** @description The FinancialAccount that received the funds. */ + /** + * @nullable + * @description The FinancialAccount that received the funds. + */ financial_account?: string | null; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26958,14 +32320,20 @@ export interface components { * @enum {string} */ object: "treasury.received_credit"; - /** @description Details describing when a ReceivedCredit may be reversed. */ + /** + * @nullable + * @description Details describing when a ReceivedCredit may be reversed. + */ reversal_details?: components["schemas"]["treasury_received_credits_resource_reversal_details"] | null; /** * @description Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field. * @enum {string} */ status: "failed" | "succeeded"; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -26976,25 +32344,32 @@ export interface components { /** @description Amount (in cents) transferred. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; /** + * @nullable * @description Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen. * @enum {string|null} */ failure_code?: "account_closed" | "account_frozen" | "insufficient_funds" | "international_transaction" | "other" | null; - /** @description The FinancialAccount that funds were pulled from. */ + /** + * @nullable + * @description The FinancialAccount that funds were pulled from. + */ financial_account?: string | null; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -27012,14 +32387,20 @@ export interface components { * @enum {string} */ object: "treasury.received_debit"; - /** @description Details describing when a ReceivedDebit might be reversed. */ + /** + * @nullable + * @description Details describing when a ReceivedDebit might be reversed. + */ reversal_details?: components["schemas"]["treasury_received_debits_resource_reversal_details"] | null; /** * @description Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`. * @enum {string} */ status: "failed" | "succeeded"; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -27031,19 +32412,20 @@ export interface components { amount: number; balance_impact: components["schemas"]["treasury_transactions_resource_balance_impact"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; /** * TreasuryTransactionsResourceTransactionEntryList + * @nullable * @description A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. */ entries?: { @@ -27056,14 +32438,23 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/treasury/transaction_entries + */ url: string; } | null; /** @description The FinancialAccount associated with this object. */ financial_account: string; - /** @description ID of the flow that created the Transaction. */ + /** + * @nullable + * @description ID of the flow that created the Transaction. + */ flow?: string | null; - /** @description Details of the flow that created the Transaction. */ + /** + * @nullable + * @description Details of the flow that created the Transaction. + */ flow_details?: components["schemas"]["treasury_transactions_resource_flow_details"] | null; /** * @description Type of the flow that created the Transaction. @@ -27093,25 +32484,31 @@ export interface components { "treasury.transaction_entry": { balance_impact: components["schemas"]["treasury_transactions_resource_balance_impact"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** - * Format: unix-time * @description When the TransactionEntry will impact the FinancialAccount's balance. + * @format unix-time */ effective_at: number; /** @description The FinancialAccount associated with this object. */ financial_account: string; - /** @description Token of the flow associated with the TransactionEntry. */ + /** + * @nullable + * @description Token of the flow associated with the TransactionEntry. + */ flow?: string | null; - /** @description Details of the flow associated with the TransactionEntry. */ + /** + * @nullable + * @description Details of the flow associated with the TransactionEntry. + */ flow_details?: components["schemas"]["treasury_transactions_resource_flow_details"] | null; /** * @description Type of the flow associated with the TransactionEntry. @@ -27142,7 +32539,10 @@ export interface components { treasury_financial_accounts_resource_aba_record: { /** @description The name of the person or business that owns the bank account. */ account_holder_name: string; - /** @description The account number. */ + /** + * @nullable + * @description The account number. + */ account_number?: string | null; /** @description The last four characters of the account number. */ account_number_last4: string; @@ -27269,11 +32669,13 @@ export interface components { */ treasury_financial_accounts_resource_platform_restrictions: { /** + * @nullable * @description Restricts all inbound money movement. * @enum {string|null} */ inbound_flows?: "restricted" | "unrestricted" | null; /** + * @nullable * @description Restricts all outbound money movement. * @enum {string|null} */ @@ -27281,7 +32683,10 @@ export interface components { }; /** TreasuryFinancialAccountsResourceStatusDetails */ treasury_financial_accounts_resource_status_details: { - /** @description Details related to the closure of this FinancialAccount */ + /** + * @nullable + * @description Details related to the closure of this FinancialAccount + */ closed?: components["schemas"]["treasury_financial_accounts_resource_closed_status_details"] | null; }; /** @@ -27310,6 +32715,7 @@ export interface components { */ code: "activating" | "capability_not_requested" | "financial_account_closed" | "rejected_other" | "rejected_unsupported_business" | "requirements_past_due" | "requirements_pending_verification" | "restricted_by_platform" | "restricted_other"; /** + * @nullable * @description Represents what the user should do, if anything, to activate the Feature. * @enum {string|null} */ @@ -27330,24 +32736,30 @@ export interface components { }; /** TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows */ treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows: { - /** @description If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return. */ + /** + * @nullable + * @description If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return. + */ received_debit?: string | null; }; /** TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions */ treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when an InboundTransfer changed status to `canceled`. + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an InboundTransfer changed status to `failed`. + * @format unix-time */ failed_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an InboundTransfer changed status to `succeeded`. + * @format unix-time */ succeeded_at?: number | null; }; @@ -27358,7 +32770,10 @@ export interface components { }; /** TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails */ treasury_outbound_payments_resource_outbound_payment_resource_end_user_details: { - /** @description IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked. */ + /** + * @nullable + * @description IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked. + */ ip_address?: string | null; /** @description `true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`. */ present: boolean; @@ -27366,23 +32781,27 @@ export interface components { /** TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions */ treasury_outbound_payments_resource_outbound_payment_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundPayment changed status to `canceled`. + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundPayment changed status to `failed`. + * @format unix-time */ failed_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundPayment changed status to `posted`. + * @format unix-time */ posted_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundPayment changed status to `returned`. + * @format unix-time */ returned_at?: number | null; }; @@ -27408,11 +32827,20 @@ export interface components { }; /** TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails */ treasury_outbound_payments_resource_us_domestic_wire_tracking_details: { - /** @description CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network. + */ chips?: string | null; - /** @description IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. + */ imad?: string | null; - /** @description OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. + */ omad?: string | null; }; /** TreasuryOutboundTransfersResourceACHTrackingDetails */ @@ -27443,58 +32871,91 @@ export interface components { /** TreasuryOutboundTransfersResourceStatusTransitions */ treasury_outbound_transfers_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundTransfer changed status to `canceled` + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundTransfer changed status to `failed` + * @format unix-time */ failed_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundTransfer changed status to `posted` + * @format unix-time */ posted_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundTransfer changed status to `returned` + * @format unix-time */ returned_at?: number | null; }; /** TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails */ treasury_outbound_transfers_resource_us_domestic_wire_tracking_details: { - /** @description CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. + */ chips?: string | null; - /** @description IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. + */ imad?: string | null; - /** @description OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. + */ omad?: string | null; }; /** TreasuryReceivedCreditsResourceLinkedFlows */ treasury_received_credits_resource_linked_flows: { - /** @description The CreditReversal created as a result of this ReceivedCredit being reversed. */ + /** + * @nullable + * @description The CreditReversal created as a result of this ReceivedCredit being reversed. + */ credit_reversal?: string | null; - /** @description Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. */ + /** + * @nullable + * @description Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. + */ issuing_authorization?: string | null; - /** @description Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object. */ + /** + * @nullable + * @description Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object. + */ issuing_transaction?: string | null; - /** @description ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. */ + /** + * @nullable + * @description ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. + */ source_flow?: string | null; - /** @description The expandable object of the source flow. */ + /** + * @nullable + * @description The expandable object of the source flow. + */ source_flow_details?: components["schemas"]["treasury_received_credits_resource_source_flows_details"] | null; - /** @description The type of flow that originated the ReceivedCredit (for example, `outbound_payment`). */ + /** + * @nullable + * @description The type of flow that originated the ReceivedCredit (for example, `outbound_payment`). + */ source_flow_type?: string | null; }; /** TreasuryReceivedCreditsResourceReversalDetails */ treasury_received_credits_resource_reversal_details: { /** - * Format: unix-time + * @nullable * @description Time before which a ReceivedCredit can be reversed. + * @format unix-time */ deadline?: number | null; /** + * @nullable * @description Set if a ReceivedCredit cannot be reversed. * @enum {string|null} */ @@ -27515,37 +32976,58 @@ export interface components { /** TreasuryReceivedCreditsResourceStatusTransitions */ treasury_received_credits_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when the CreditReversal changed status to `posted` + * @format unix-time */ posted_at?: number | null; }; /** TreasuryReceivedDebitsResourceDebitReversalLinkedFlows */ treasury_received_debits_resource_debit_reversal_linked_flows: { - /** @description Set if there is an Issuing dispute associated with the DebitReversal. */ + /** + * @nullable + * @description Set if there is an Issuing dispute associated with the DebitReversal. + */ issuing_dispute?: string | null; }; /** TreasuryReceivedDebitsResourceLinkedFlows */ treasury_received_debits_resource_linked_flows: { - /** @description The DebitReversal created as a result of this ReceivedDebit being reversed. */ + /** + * @nullable + * @description The DebitReversal created as a result of this ReceivedDebit being reversed. + */ debit_reversal?: string | null; - /** @description Set if the ReceivedDebit is associated with an InboundTransfer's return of funds. */ + /** + * @nullable + * @description Set if the ReceivedDebit is associated with an InboundTransfer's return of funds. + */ inbound_transfer?: string | null; - /** @description Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. */ + /** + * @nullable + * @description Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. + */ issuing_authorization?: string | null; - /** @description Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object. */ + /** + * @nullable + * @description Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object. + */ issuing_transaction?: string | null; - /** @description Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object. */ + /** + * @nullable + * @description Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object. + */ payout?: string | null; }; /** TreasuryReceivedDebitsResourceReversalDetails */ treasury_received_debits_resource_reversal_details: { /** - * Format: unix-time + * @nullable * @description Time before which a ReceivedDebit can be reversed. + * @format unix-time */ deadline?: number | null; /** + * @nullable * @description Set if a ReceivedDebit can't be reversed. * @enum {string|null} */ @@ -27554,17 +33036,24 @@ export interface components { /** TreasuryReceivedDebitsResourceStatusTransitions */ treasury_received_debits_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when the DebitReversal changed status to `completed`. + * @format unix-time */ completed_at?: number | null; }; /** TreasurySharedResourceBillingDetails */ treasury_shared_resource_billing_details: { address: components["schemas"]["address"]; - /** @description Email address. */ + /** + * @nullable + * @description Email address. + */ email?: string | null; - /** @description Full name. */ + /** + * @nullable + * @description Full name. + */ name?: string | null; }; /** TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails */ @@ -27587,23 +33076,34 @@ export interface components { }; /** TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount */ treasury_shared_resource_initiating_payment_method_details_us_bank_account: { - /** @description Bank name. */ + /** + * @nullable + * @description Bank name. + */ bank_name?: string | null; - /** @description The last four digits of the bank account number. */ + /** + * @nullable + * @description The last four digits of the bank account number. + */ last4?: string | null; - /** @description The routing number for the bank account. */ + /** + * @nullable + * @description The routing number for the bank account. + */ routing_number?: string | null; }; /** TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions */ treasury_transactions_resource_abstract_transaction_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when the Transaction changed status to `posted`. + * @format unix-time */ posted_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when the Transaction changed status to `void`. + * @format unix-time */ void_at?: number | null; }; @@ -27637,7 +33137,10 @@ export interface components { }; /** us_bank_account_networks */ us_bank_account_networks: { - /** @description The preferred network. */ + /** + * @nullable + * @description The preferred network. + */ preferred?: string | null; /** @description All supported networks. */ supported: ("ach" | "us_domestic_wire")[]; @@ -27666,8 +33169,8 @@ export interface components { /** @description The ID of the subscription item this usage record contains data for. */ subscription_item: string; /** - * Format: unix-time * @description The timestamp when this usage occurred. + * @format unix-time */ timestamp: number; }; @@ -27678,7 +33181,10 @@ export interface components { usage_record_summary: { /** @description Unique identifier for the object. */ id: string; - /** @description The invoice in which this usage period has been billed for. */ + /** + * @nullable + * @description The invoice in which this usage period has been billed for. + */ invoice?: string | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -27712,16 +33218,25 @@ export interface components { * Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure) */ webhook_endpoint: { - /** @description The API version events are rendered as for this webhook endpoint. */ + /** + * @nullable + * @description The API version events are rendered as for this webhook endpoint. + */ api_version?: string | null; - /** @description The ID of the associated Connect application. */ + /** + * @nullable + * @description The ID of the associated Connect application. + */ application?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description An optional description of what the webhook is used for. */ + /** + * @nullable + * @description An optional description of what the webhook is used for. + */ description?: string | null; /** @description The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ enabled_events: string[]; @@ -28079,7 +33594,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/accounts + */ url: string; }; }; @@ -28116,7 +33634,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -28137,7 +33655,7 @@ export interface operations { /** annual_revenue_specs */ annual_revenue?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; fiscal_year_end: string; }; @@ -28146,7 +33664,7 @@ export interface operations { /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; }; name?: string; @@ -28436,7 +33954,7 @@ export interface operations { directors_provided?: boolean; /** company_directorship_declaration */ directorship_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -28450,7 +33968,7 @@ export interface operations { owners_provided?: boolean; /** company_ownership_declaration */ ownership_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -28499,8 +34017,8 @@ export interface operations { /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported. */ country?: string; /** - * Format: currency * @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + * @format currency */ default_currency?: string; /** @@ -28667,7 +34185,7 @@ export interface operations { card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -28708,7 +34226,7 @@ export interface operations { treasury?: { /** settings_terms_of_service_specs */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -28720,7 +34238,7 @@ export interface operations { * @description Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty. */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; service_agreement?: string; @@ -28815,7 +34333,7 @@ export interface operations { /** annual_revenue_specs */ annual_revenue?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; fiscal_year_end: string; }; @@ -28824,7 +34342,7 @@ export interface operations { /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; }; name?: string; @@ -29114,7 +34632,7 @@ export interface operations { directors_provided?: boolean; /** company_directorship_declaration */ directorship_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -29128,7 +34646,7 @@ export interface operations { owners_provided?: boolean; /** company_ownership_declaration */ ownership_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -29152,8 +34670,8 @@ export interface operations { }; }; /** - * Format: currency * @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + * @format currency */ default_currency?: string; /** @@ -29320,7 +34838,7 @@ export interface operations { card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -29365,7 +34883,7 @@ export interface operations { treasury?: { /** settings_terms_of_service_specs */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -29377,7 +34895,7 @@ export interface operations { * @description Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty. */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; service_agreement?: string; @@ -29463,7 +34981,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -29882,7 +35400,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -30210,7 +35728,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -30443,7 +35961,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -30736,7 +36254,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -30969,7 +36487,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -31257,7 +36775,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/apple_pay/domains + */ url: string; }; }; @@ -31429,7 +36950,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/application_fees + */ url: string; }; }; @@ -31748,7 +37272,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/apps/secrets + */ url: string; }; }; @@ -31777,8 +37304,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The Unix timestamp for the expiry time of the secret, after which the secret deletes. + * @format unix-time */ expires_at?: number; /** @description A name for the secret that's unique within the scope. */ @@ -31997,7 +37524,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/balance_transactions + */ url: string; }; }; @@ -32103,7 +37633,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/balance_transactions + */ url: string; }; }; @@ -32198,7 +37731,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/alerts + */ url: string; }; }; @@ -32514,7 +38050,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/credit_grants + */ url: string; }; }; @@ -32608,7 +38147,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/credit_grants + */ url: string; }; }; @@ -32641,7 +38183,7 @@ export interface operations { amount: { /** monetary_amount_param */ monetary?: { - /** Format: currency */ + /** @format currency */ currency: string; value: number; }; @@ -32667,15 +38209,15 @@ export interface operations { /** @description ID of the customer to receive the billing credits. */ customer: string; /** - * Format: unix-time * @description The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified. + * @format unix-time */ effective_at?: number; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The time when the billing credits expire. If not specified, the billing credits don't expire. + * @format unix-time */ expires_at?: number; /** @description Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format. */ @@ -32941,8 +38483,8 @@ export interface operations { [key: string]: string; }; /** - * Format: unix-time * @description The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified. + * @format unix-time */ timestamp?: number; }; @@ -33008,7 +38550,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/meters + */ url: string; }; }; @@ -33260,7 +38805,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/meters/[^/]+/event_summaries + */ url: string; }; }; @@ -33356,7 +38904,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing_portal/configurations + */ url: string; }; }; @@ -33780,7 +39331,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/charges + */ url: string; }; }; @@ -33833,8 +39387,8 @@ export interface operations { object?: "card"; } | string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description The ID of an existing customer that will be charged in this request. */ @@ -33956,6 +39510,7 @@ export interface operations { "application/json": { data: components["schemas"]["charge"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -34486,8 +40041,8 @@ export interface operations { "application/x-www-form-urlencoded": { amount?: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Customer whose customer balance to refund from. */ @@ -34767,8 +40322,8 @@ export interface operations { terms_of_service?: "none" | "required"; }; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. + * @format currency */ currency?: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ @@ -34877,8 +40432,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. + * @format unix-time */ expires_at?: number; /** @@ -34929,7 +40484,7 @@ export interface operations { price?: string; /** price_data_with_product_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product?: string; /** product_data */ @@ -34951,7 +40506,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -35390,7 +40945,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -35423,7 +40978,7 @@ export interface operations { */ subscription_data?: { application_fee_percent?: number; - /** Format: unix-time */ + /** @format unix-time */ billing_cycle_anchor?: number; default_tax_rates?: string[]; description?: string; @@ -35447,7 +41002,7 @@ export interface operations { amount_percent?: number; destination: string; }; - /** Format: unix-time */ + /** @format unix-time */ trial_end?: number; trial_period_days?: number; /** trial_settings_config */ @@ -35716,7 +41271,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/climate/orders + */ url: string; }; }; @@ -35760,8 +41318,8 @@ export interface operations { [key: string]: string; }; /** - * Format: decimal * @description Requested number of tons for the order. Either this or `amount` must be specified. + * @format decimal */ metric_tons?: string; /** @description Unique identifier of the Climate product. */ @@ -35952,7 +41510,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/climate/products + */ url: string; }; }; @@ -36043,7 +41604,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/climate/suppliers + */ url: string; }; }; @@ -36172,7 +41736,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/country_specs + */ url: string; }; }; @@ -36270,7 +41837,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/coupons + */ url: string; }; }; @@ -36306,8 +41876,8 @@ export interface operations { products?: string[]; }; /** - * Format: currency * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). + * @format currency */ currency?: string; /** @description Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ @@ -36338,8 +41908,8 @@ export interface operations { /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). */ percent_off?: number; /** - * Format: unix-time * @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. + * @format unix-time */ redeem_by?: number; }; @@ -36568,8 +42138,8 @@ export interface operations { /** @description The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ credit_amount?: number; /** - * Format: unix-time * @description The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. + * @format unix-time */ effective_at?: number; /** @@ -36596,7 +42166,7 @@ export interface operations { /** @enum {string} */ type: "custom_line_item" | "invoice_line_item"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The credit note's memo appears on the credit note PDF. */ @@ -36677,7 +42247,7 @@ export interface operations { /** @enum {string} */ type: "custom_line_item" | "invoice_line_item"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The credit note's memo appears on the credit note PDF. */ @@ -36763,7 +42333,7 @@ export interface operations { /** @enum {string} */ type: "custom_line_item" | "invoice_line_item"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The credit note's memo appears on the credit note PDF. */ @@ -37122,7 +42692,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/customers + */ url: string; }; }; @@ -37303,6 +42876,7 @@ export interface operations { "application/json": { data: components["schemas"]["customer"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -37394,7 +42968,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -37643,8 +43217,8 @@ export interface operations { /** @description The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -37840,7 +43414,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -38175,7 +43749,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -38671,8 +44245,8 @@ export interface operations { type: "eu_bank_transfer" | "gb_bank_transfer" | "jp_bank_transfer" | "mx_bank_transfer" | "us_bank_transfer"; }; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Specifies which fields in the response should be expanded. */ @@ -38883,7 +44457,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -39220,13 +44794,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -39248,13 +44822,13 @@ export interface operations { }; }; /** - * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. + * @format unix-time */ backdate_start_date?: number; /** - * Format: unix-time * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. + * @format unix-time */ billing_cycle_anchor?: number; /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ @@ -39263,8 +44837,8 @@ export interface operations { reset_billing_cycle_anchor?: boolean; } | ""; /** - * Format: unix-time * @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. + * @format unix-time */ cancel_at?: number; /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ @@ -39277,8 +44851,8 @@ export interface operations { /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ @@ -39326,7 +44900,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -39338,7 +44912,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -39553,13 +45127,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -39658,7 +45232,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -39670,7 +45244,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -39686,7 +45260,7 @@ export interface operations { pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; - /** Format: unix-time */ + /** @format unix-time */ resumes_at?: number; } | ""; /** @@ -39778,8 +45352,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + * @format unix-time */ proration_date?: number; /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ @@ -40168,7 +45742,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/disputes + */ url: string; }; }; @@ -40519,7 +46096,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/entitlements/features + */ url: string; }; }; @@ -40796,7 +46376,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/events + */ url: string; }; }; @@ -40887,7 +46470,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/exchange_rates + */ url: string; }; }; @@ -40990,7 +46576,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/file_links + */ url: string; }; }; @@ -41019,8 +46608,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The link isn't usable after this future timestamp. + * @format unix-time */ expires_at?: number; /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. */ @@ -41181,7 +46770,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/files + */ url: string; }; }; @@ -41210,8 +46802,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: binary * @description A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol. + * @format binary */ file: string; /** @@ -41220,7 +46812,7 @@ export interface operations { */ file_link_data?: { create: boolean; - /** Format: unix-time */ + /** @format unix-time */ expires_at?: number; metadata?: { [key: string]: string; @@ -41338,7 +46930,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/financial_connections/accounts + */ url: string; }; }; @@ -41761,7 +47356,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/financial_connections/transactions + */ url: string; }; }; @@ -42020,7 +47618,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/identity/verification_reports + */ url: string; }; }; @@ -42123,7 +47724,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/identity/verification_sessions + */ url: string; }; }; @@ -42613,7 +48217,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/invoiceitems + */ url: string; }; }; @@ -42642,8 +48249,8 @@ export interface operations { /** @description The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ amount?: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description The ID of the customer who will be billed when this invoice item is billed. */ @@ -42671,9 +48278,9 @@ export interface operations { * @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 */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; /** @description The ID of the price object. One of `price` or `price_data` is required. */ @@ -42683,13 +48290,13 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @description Non-negative integer. The quantity of units for the invoice item. */ @@ -42708,8 +48315,8 @@ export interface operations { /** @description The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ unit_amount?: number; /** - * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + * @format decimal */ unit_amount_decimal?: string; }; @@ -42809,9 +48416,9 @@ export interface operations { * @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 */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; /** @description The ID of the price object. One of `price` or `price_data` is required. */ @@ -42821,13 +48428,13 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @description Non-negative integer. The quantity of units for the invoice item. */ @@ -42844,8 +48451,8 @@ export interface operations { /** @description The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ unit_amount?: number; /** - * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + * @format decimal */ unit_amount_decimal?: string; }; @@ -42965,7 +48572,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/invoices + */ url: string; }; }; @@ -43011,8 +48621,8 @@ export interface operations { }; }; /** - * Format: unix-time * @description The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. + * @format unix-time */ automatically_finalizes_at?: number; /** @@ -43021,8 +48631,8 @@ export interface operations { */ collection_method?: "charge_automatically" | "send_invoice"; /** - * Format: currency * @description The currency to create this invoice in. Defaults to that of `customer` if not specified. + * @format currency */ currency?: string; /** @description A list of up to 4 custom fields to be displayed on the invoice. */ @@ -43049,13 +48659,13 @@ export interface operations { promotion_code?: string; }[] | ""; /** - * Format: unix-time * @description The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. + * @format unix-time */ due_date?: number; /** - * Format: unix-time * @description The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. + * @format unix-time */ effective_at?: number; /** @description Specifies which fields in the response should be expanded. */ @@ -43200,7 +48810,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -43299,8 +48909,8 @@ export interface operations { /** @description The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; /** - * Format: currency * @description The currency to preview this invoice in. Defaults to that of `customer` if not specified. + * @format currency */ currency?: string; /** @description The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ @@ -43354,7 +48964,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; discountable?: boolean; @@ -43369,21 +48979,21 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43392,7 +49002,7 @@ export interface operations { tax_code?: string | ""; tax_rates?: string[] | ""; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @@ -43430,13 +49040,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43497,7 +49107,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43509,7 +49119,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43564,7 +49174,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43576,7 +49186,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43584,11 +49194,11 @@ export interface operations { }[]; /** @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** Format: unix-time */ + /** @format unix-time */ proration_date?: number; /** @enum {string} */ resume_at?: "now"; - /** Format: unix-time */ + /** @format unix-time */ start_date?: number; trial_end?: "now" | number; }; @@ -43647,6 +49257,7 @@ export interface operations { "application/json": { data: components["schemas"]["invoice"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -43735,7 +49346,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; discountable?: boolean; @@ -43750,21 +49361,21 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43773,7 +49384,7 @@ export interface operations { tax_code?: string | ""; tax_rates?: string[] | ""; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ @@ -43802,13 +49413,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43869,7 +49480,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43881,7 +49492,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43943,7 +49554,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43955,7 +49566,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43963,11 +49574,11 @@ export interface operations { }[]; /** @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** Format: unix-time */ + /** @format unix-time */ proration_date?: number; /** @enum {string} */ resume_at?: "now"; - /** Format: unix-time */ + /** @format unix-time */ start_date?: number; trial_end?: "now" | number; }; @@ -43990,7 +49601,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -44002,7 +49613,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44116,7 +49727,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; discountable?: boolean; @@ -44131,21 +49742,21 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44154,7 +49765,7 @@ export interface operations { tax_code?: string | ""; tax_rates?: string[] | ""; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ @@ -44185,13 +49796,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44252,7 +49863,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -44264,7 +49875,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44328,7 +49939,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -44340,7 +49951,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44348,11 +49959,11 @@ export interface operations { }[]; /** @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** Format: unix-time */ + /** @format unix-time */ proration_date?: number; /** @enum {string} */ resume_at?: "now"; - /** Format: unix-time */ + /** @format unix-time */ start_date?: number; trial_end?: "now" | number; }; @@ -44375,7 +49986,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -44387,7 +49998,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44516,8 +50127,8 @@ export interface operations { }; }; /** - * Format: unix-time * @description The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. To turn off automatic finalization, set `auto_advance` to false. + * @format unix-time */ automatically_finalizes_at?: number; /** @@ -44547,8 +50158,8 @@ export interface operations { promotion_code?: string; }[] | ""; /** - * Format: unix-time * @description The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. + * @format unix-time */ due_date?: number; /** @description The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. */ @@ -44678,7 +50289,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -44812,15 +50423,15 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data_with_product_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product?: string; /** product_data */ @@ -44836,7 +50447,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -45016,9 +50627,9 @@ export interface operations { * @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 */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; /** @description The ID of the price object. One of `price` or `price_data` is required. */ @@ -45028,7 +50639,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product?: string; /** product_data */ @@ -45044,7 +50655,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @description Non-negative integer. The quantity of units for the line item. */ @@ -45304,15 +50915,15 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data_with_product_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product?: string; /** product_data */ @@ -45328,7 +50939,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -45462,7 +51073,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/authorizations + */ url: string; }; }; @@ -45696,7 +51310,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/cardholders + */ url: string; }; }; @@ -45757,7 +51374,7 @@ export interface operations { card_issuing?: { /** terms_acceptance_param */ user_terms_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -45929,7 +51546,7 @@ export interface operations { card_issuing?: { /** terms_acceptance_param */ user_terms_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -46066,7 +51683,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/cards + */ url: string; }; }; @@ -46395,7 +52015,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/disputes + */ url: string; }; }; @@ -46770,7 +52393,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/personalization_designs + */ url: string; }; }; @@ -46998,7 +52624,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/physical_bundles + */ url: string; }; }; @@ -47327,7 +52956,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/transactions + */ url: string; }; }; @@ -47570,7 +53202,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/financial_connections/accounts + */ url: string; }; }; @@ -47844,7 +53479,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_intents + */ url: string; }; }; @@ -47902,8 +53540,8 @@ export interface operations { */ confirmation_token?: string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @@ -47926,7 +53564,7 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - /** Format: unix-time */ + /** @format unix-time */ accepted_at?: number; /** offline_param */ offline?: Record; @@ -48220,13 +53858,13 @@ export interface operations { /** @enum {string} */ amount_type: "fixed" | "maximum"; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -48403,7 +54041,7 @@ export interface operations { } | ""; pix?: { expires_after_seconds?: number; - /** Format: unix-time */ + /** @format unix-time */ expires_at?: number; /** @enum {string} */ setup_future_usage?: "none"; @@ -48603,6 +54241,7 @@ export interface operations { "application/json": { data: components["schemas"]["payment_intent"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -48688,8 +54327,8 @@ export interface operations { */ capture_method?: "automatic" | "automatic_async" | "manual"; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @@ -48977,13 +54616,13 @@ export interface operations { /** @enum {string} */ amount_type: "fixed" | "maximum"; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -49160,7 +54799,7 @@ export interface operations { } | ""; pix?: { expires_after_seconds?: number; - /** Format: unix-time */ + /** @format unix-time */ expires_at?: number; /** @enum {string} */ setup_future_usage?: "none"; @@ -49336,8 +54975,8 @@ export interface operations { */ amount?: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -49507,7 +55146,7 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - /** Format: unix-time */ + /** @format unix-time */ accepted_at?: number; /** offline_param */ offline?: Record; @@ -49800,13 +55439,13 @@ export interface operations { /** @enum {string} */ amount_type: "fixed" | "maximum"; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -49983,7 +55622,7 @@ export interface operations { } | ""; pix?: { expires_after_seconds?: number; - /** Format: unix-time */ + /** @format unix-time */ expires_at?: number; /** @enum {string} */ setup_future_usage?: "none"; @@ -50277,7 +55916,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_links + */ url: string; }; }; @@ -50359,8 +56001,8 @@ export interface operations { terms_of_service?: "none" | "required"; }; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. + * @format currency */ currency?: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ @@ -50992,7 +56634,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_method_configurations + */ url: string; }; }; @@ -52115,7 +57760,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_method_domains + */ url: string; }; }; @@ -52328,7 +57976,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_methods + */ url: string; }; }; @@ -52979,7 +58630,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payouts + */ url: string; }; }; @@ -53008,8 +58662,8 @@ export interface operations { /** @description A positive integer in cents representing how much to payout. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -53267,7 +58921,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/plans + */ url: string; }; }; @@ -53303,8 +58960,8 @@ export interface operations { /** @description A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis. */ amount?: number; /** - * Format: decimal * @description Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. + * @format decimal */ amount_decimal?: string; /** @@ -53313,8 +58970,8 @@ export interface operations { */ billing_scheme?: "per_unit" | "tiered"; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Specifies which fields in the response should be expanded. */ @@ -53351,10 +59008,10 @@ export interface operations { /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; @@ -53589,7 +59246,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/prices + */ url: string; }; }; @@ -53623,8 +59283,8 @@ export interface operations { */ billing_scheme?: "per_unit" | "tiered"; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ @@ -53641,15 +59301,15 @@ export interface operations { tax_behavior?: "exclusive" | "inclusive" | "unspecified"; tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; }; @@ -53713,10 +59373,10 @@ export interface operations { /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; @@ -53739,8 +59399,8 @@ export interface operations { /** @description A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`. */ unit_amount?: number; /** - * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + * @format decimal */ unit_amount_decimal?: string; }; @@ -53798,6 +59458,7 @@ export interface operations { "application/json": { data: components["schemas"]["price"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -53887,15 +59548,15 @@ export interface operations { tax_behavior?: "exclusive" | "inclusive" | "unspecified"; tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; } | ""; @@ -53993,7 +59654,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/products + */ url: string; }; }; @@ -54026,7 +59690,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product. */ default_price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -54041,15 +59705,15 @@ export interface operations { tax_behavior?: "exclusive" | "inclusive" | "unspecified"; tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; }; @@ -54069,7 +59733,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ @@ -54170,6 +59834,7 @@ export interface operations { "application/json": { data: components["schemas"]["product"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -54568,7 +60233,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/promotion_codes + */ url: string; }; }; @@ -54609,8 +60277,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`. + * @format unix-time */ expires_at?: number; /** @description A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`. */ @@ -54631,7 +60299,7 @@ export interface operations { }; first_time_transaction?: boolean; minimum_amount?: number; - /** Format: currency */ + /** @format currency */ minimum_amount_currency?: string; }; }; @@ -54794,7 +60462,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/quotes + */ url: string; }; }; @@ -54857,8 +60528,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. + * @format unix-time */ expires_at?: number; /** @description A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ @@ -54896,7 +60567,7 @@ export interface operations { price?: string; /** price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -54908,7 +60579,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -55051,8 +60722,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. + * @format unix-time */ expires_at?: number; /** @description A footer that will be displayed on the quote PDF. */ @@ -55083,7 +60754,7 @@ export interface operations { price?: string; /** price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -55095,7 +60766,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -55296,8 +60967,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. + * @format unix-time */ expires_at?: number; }; @@ -55466,7 +61137,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/radar/early_fraud_warnings + */ url: string; }; }; @@ -55568,7 +61242,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/radar/value_list_items + */ url: string; }; }; @@ -55745,7 +61422,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/radar/value_lists + */ url: string; }; }; @@ -55977,7 +61657,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/refunds + */ url: string; }; }; @@ -56007,8 +61690,8 @@ export interface operations { /** @description The identifier of the charge to refund. */ charge?: string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Customer whose customer balance to refund from. */ @@ -56223,7 +61906,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/reporting/report_runs + */ url: string; }; }; @@ -56258,11 +61944,11 @@ export interface operations { parameters?: { columns?: string[]; connected_account?: string; - /** Format: currency */ + /** @format currency */ currency?: string; - /** Format: unix-time */ + /** @format unix-time */ interval_end?: number; - /** Format: unix-time */ + /** @format unix-time */ interval_start?: number; payout?: string; /** @enum {string} */ @@ -56608,7 +62294,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/setup_attempts + */ url: string; }; }; @@ -56678,7 +62367,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/setup_intents + */ url: string; }; }; @@ -56747,7 +62439,7 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - /** Format: unix-time */ + /** @format unix-time */ accepted_at?: number; /** offline_param */ offline?: Record; @@ -56975,16 +62667,16 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; - /** Format: currency */ + /** @format currency */ currency: string; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -57065,7 +62757,7 @@ export interface operations { */ single_use?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; }; /** @@ -57386,16 +63078,16 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; - /** Format: currency */ + /** @format currency */ currency: string; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -57560,7 +63252,7 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - /** Format: unix-time */ + /** @format unix-time */ accepted_at?: number; /** offline_param */ offline?: Record; @@ -57791,16 +63483,16 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; - /** Format: currency */ + /** @format currency */ currency: string; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -57995,7 +63687,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/shipping_rates + */ url: string; }; }; @@ -58049,7 +63744,7 @@ export interface operations { */ fixed_amount?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -58236,7 +63931,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/sigma/scheduled_query_runs + */ url: string; }; }; @@ -58303,8 +64001,8 @@ export interface operations { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ amount?: number; /** - * Format: currency * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. + * @format currency */ currency?: string; /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ @@ -58323,7 +64021,7 @@ export interface operations { mandate?: { /** mandate_acceptance_params */ acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; /** mandate_offline_acceptance_params */ @@ -58332,7 +64030,7 @@ export interface operations { }; /** mandate_online_acceptance_params */ online?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -58344,7 +64042,7 @@ export interface operations { user_agent?: string; }; amount?: number | ""; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ interval?: "one_time" | "scheduled" | "variable"; @@ -58396,7 +64094,7 @@ export interface operations { source_order?: { items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; parent?: string; @@ -58516,7 +64214,7 @@ export interface operations { mandate?: { /** mandate_acceptance_params */ acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; /** mandate_offline_acceptance_params */ @@ -58525,7 +64223,7 @@ export interface operations { }; /** mandate_online_acceptance_params */ online?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -58537,7 +64235,7 @@ export interface operations { user_agent?: string; }; amount?: number | ""; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ interval?: "one_time" | "scheduled" | "variable"; @@ -58573,7 +64271,7 @@ export interface operations { source_order?: { items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; parent?: string; @@ -58834,7 +64532,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/subscription_items + */ url: string; }; }; @@ -58894,7 +64595,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -58906,7 +64607,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @@ -58915,8 +64616,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @format unix-time */ proration_date?: number; /** @description The quantity you'd like to apply to the subscription item you're creating. */ @@ -59035,7 +64736,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59047,7 +64748,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @@ -59056,8 +64757,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @format unix-time */ proration_date?: number; /** @description The quantity you'd like to apply to the subscription item you're creating. */ @@ -59108,8 +64809,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @format unix-time */ proration_date?: number; }; @@ -59307,7 +65008,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/subscription_schedules + */ url: string; }; }; @@ -59402,13 +65106,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59434,7 +65138,7 @@ export interface operations { /** @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; coupon?: string; - /** Format: currency */ + /** @format currency */ currency?: string; default_payment_method?: string; default_tax_rates?: string[] | ""; @@ -59444,7 +65148,7 @@ export interface operations { discount?: string; promotion_code?: string; }[] | ""; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** invoice_settings */ invoice_settings?: { @@ -59472,7 +65176,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59484,7 +65188,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59503,7 +65207,7 @@ export interface operations { destination: string; }; trial?: boolean; - /** Format: unix-time */ + /** @format unix-time */ trial_end?: number; }[]; /** @description When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. */ @@ -59647,13 +65351,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59714,7 +65418,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59726,7 +65430,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59931,7 +65635,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/subscriptions + */ url: string; }; }; @@ -59967,13 +65674,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59995,13 +65702,13 @@ export interface operations { }; }; /** - * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. + * @format unix-time */ backdate_start_date?: number; /** - * Format: unix-time * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. + * @format unix-time */ billing_cycle_anchor?: number; /** @@ -60021,8 +65728,8 @@ export interface operations { reset_billing_cycle_anchor?: boolean; } | ""; /** - * Format: unix-time * @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. + * @format unix-time */ cancel_at?: number; /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ @@ -60035,8 +65742,8 @@ export interface operations { /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description The identifier of the customer to subscribe. */ @@ -60088,7 +65795,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -60100,7 +65807,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -60286,6 +65993,7 @@ export interface operations { "application/json": { data: components["schemas"]["subscription"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -60369,13 +66077,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -60476,7 +66184,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -60488,7 +66196,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -60506,7 +66214,7 @@ export interface operations { pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; - /** Format: unix-time */ + /** @format unix-time */ resumes_at?: number; } | ""; /** @@ -60598,8 +66306,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + * @format unix-time */ proration_date?: number; /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ @@ -60757,8 +66465,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @format unix-time */ proration_date?: number; }; @@ -60796,8 +66504,8 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`. */ @@ -60969,7 +66677,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/calculations/[^/]+/line_items + */ url: string; }; }; @@ -61024,7 +66735,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/registrations + */ url: string; }; }; @@ -61649,8 +67363,8 @@ export interface operations { /** @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. + * @format unix-time */ expires_at?: number; }; @@ -61872,8 +67586,8 @@ export interface operations { [key: string]: string; }; /** - * Format: unix-time * @description The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time. + * @format unix-time */ posted_at?: number; /** @description A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals. */ @@ -62050,7 +67764,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/transactions/[^/]+/line_items + */ url: string; }; }; @@ -62392,7 +68109,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax_rates + */ url: string; }; }; @@ -62605,7 +68325,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/terminal/configurations + */ url: string; }; }; @@ -63099,7 +68822,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/terminal/locations + */ url: string; }; }; @@ -63747,7 +69473,7 @@ export interface operations { * @description Cart */ cart?: { - /** Format: currency */ + /** @format currency */ currency: string; line_items: { amount: number; @@ -64033,8 +69759,8 @@ export interface operations { /** @description Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Specifies which fields in the response should be expanded. */ @@ -64093,8 +69819,8 @@ export interface operations { /** @description Card associated with this authorization. */ card: string; /** - * Format: currency * @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -64118,19 +69844,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -64143,13 +69869,13 @@ export interface operations { */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ @@ -64157,8 +69883,8 @@ export interface operations { /** @description The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ merchant_amount?: number; /** - * Format: currency * @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ merchant_currency?: string; /** @@ -64278,19 +70004,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -64299,7 +70025,7 @@ export interface operations { }; /** flight_specs */ flight?: { - /** Format: unix-time */ + /** @format unix-time */ departure_at?: number; passenger_name?: string; refundable?: boolean; @@ -64316,24 +70042,24 @@ export interface operations { /** fuel_specs */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; /** lodging_specs */ lodging?: { - /** Format: unix-time */ + /** @format unix-time */ check_in_at?: number; nights?: number; }; receipt?: { description?: string; - /** Format: decimal */ + /** @format decimal */ quantity?: string; total?: number; unit_cost?: number; @@ -64437,19 +70163,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -64462,13 +70188,13 @@ export interface operations { */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; }; @@ -64944,8 +70670,8 @@ export interface operations { /** @description The date that the transactions are cleared and posted to user's accounts. */ clearing_date: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Specifies which fields in the response should be expanded. */ @@ -64999,8 +70725,8 @@ export interface operations { /** @description Card associated with this transaction. */ card: string; /** - * Format: currency * @description The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -65042,19 +70768,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -65063,7 +70789,7 @@ export interface operations { }; /** flight_specs */ flight?: { - /** Format: unix-time */ + /** @format unix-time */ departure_at?: number; passenger_name?: string; refundable?: boolean; @@ -65080,24 +70806,24 @@ export interface operations { /** fuel_specs */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; /** lodging_specs */ lodging?: { - /** Format: unix-time */ + /** @format unix-time */ check_in_at?: number; nights?: number; }; receipt?: { description?: string; - /** Format: decimal */ + /** @format decimal */ quantity?: string; total?: number; unit_cost?: number; @@ -65143,8 +70869,8 @@ export interface operations { /** @description Card associated with this unlinked refund transaction. */ card: string; /** - * Format: currency * @description The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -65186,19 +70912,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -65207,7 +70933,7 @@ export interface operations { }; /** flight_specs */ flight?: { - /** Format: unix-time */ + /** @format unix-time */ departure_at?: number; passenger_name?: string; refundable?: boolean; @@ -65224,24 +70950,24 @@ export interface operations { /** fuel_specs */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; /** lodging_specs */ lodging?: { - /** Format: unix-time */ + /** @format unix-time */ check_in_at?: number; nights?: number; }; receipt?: { description?: string; - /** Format: decimal */ + /** @format decimal */ quantity?: string; total?: number; unit_cost?: number; @@ -65446,7 +71172,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/test_helpers/test_clocks + */ url: string; }; }; @@ -65475,8 +71204,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The initial frozen time for this test clock. + * @format unix-time */ frozen_time: number; /** @description The name for this test clock. */ @@ -65593,8 +71322,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future. + * @format unix-time */ frozen_time: number; }; @@ -66112,8 +71841,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -66178,8 +71907,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -66282,7 +72011,7 @@ export interface operations { directors_provided?: boolean; /** company_directorship_declaration */ directorship_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -66296,7 +72025,7 @@ export interface operations { owners_provided?: boolean; /** company_ownership_declaration */ ownership_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -66420,7 +72149,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; payment_method?: string; routing_number?: string; @@ -66465,7 +72194,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -66695,7 +72424,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/topups + */ url: string; }; }; @@ -66932,7 +72664,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/transfers + */ url: string; }; }; @@ -66961,8 +72696,8 @@ export interface operations { /** @description A positive integer in cents (or local equivalent) representing how much to transfer. */ amount?: number; /** - * Format: currency * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -67602,7 +73337,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/treasury/financial_accounts + */ url: string; }; }; @@ -68146,8 +73884,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -68315,7 +74053,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/treasury/outbound_payments + */ url: string; }; }; @@ -68344,8 +74085,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in. */ @@ -68589,8 +74330,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -68980,7 +74721,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/treasury/transaction_entries + */ url: string; }; }; @@ -69185,7 +74929,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/webhook_endpoints + */ url: string; }; }; diff --git a/packages/openapi-react-query/test/fixtures/api.d.ts b/packages/openapi-react-query/test/fixtures/api.d.ts index 403dae490..efc2e260c 100644 --- a/packages/openapi-react-query/test/fixtures/api.d.ts +++ b/packages/openapi-react-query/test/fixtures/api.d.ts @@ -298,7 +298,7 @@ export interface paths { requestBody: { content: { "application/json": { - /** Format: blob */ + /** @format blob */ media: string; name: string; }; @@ -881,9 +881,9 @@ export interface components { email: string; age?: number; avatar?: string; - /** Format: date */ + /** @format date */ created_at: number; - /** Format: date */ + /** @format date */ updated_at: number; }; }; diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index b0f18c5e8..871f84502 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -7136,18 +7136,20 @@ export interface components { */ type?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the action was initiated. * @example 2020-11-14T16:29:21Z + * @format date-time */ started_at?: string; /** - * Format: date-time + * @nullable * @description A time value given in ISO8601 combined date and time format that represents when the action was completed. * @example 2020-11-14T16:30:06Z + * @format date-time */ completed_at?: string | null; /** + * @nullable * @description A unique identifier for the resource that the action is associated with. * @example 3164444 */ @@ -7159,6 +7161,7 @@ export interface components { resource_type?: string; region?: components["schemas"]["region"]; /** + * @nullable * @description A human-readable string that is used as a unique identifier for each region. * @example nyc3 */ @@ -7226,8 +7229,8 @@ export interface components { component_name?: string; /** * The end time of this step - * Format: date-time * @example 2020-11-19T20:27:18Z + * @format date-time */ ended_at?: string; /** @@ -7246,8 +7249,8 @@ export interface components { reason?: components["schemas"]["apps_deployment_progress_step_reason"]; /** * The start time of this step - * Format: date-time * @example 2020-11-19T20:27:18Z + * @format date-time */ started_at?: string; status?: components["schemas"]["apps_deployment_progress_step_status"]; @@ -7257,36 +7260,36 @@ export interface components { apps_deployment_progress: { /** * Number of unsuccessful steps - * Format: int32 * @example 3 + * @format int32 */ error_steps?: number; /** * Number of pending steps - * Format: int32 * @example 2 + * @format int32 */ pending_steps?: number; /** * Number of currently running steps - * Format: int32 * @example 2 + * @format int32 */ running_steps?: number; /** The deployment's steps */ steps?: components["schemas"]["apps_deployment_progress_step"][]; /** * Number of successful steps - * Format: int32 * @example 4 + * @format int32 */ success_steps?: number; /** A flattened summary of the steps */ summary_steps?: components["schemas"]["apps_deployment_progress_step"][]; /** * Total number of steps - * Format: int32 * @example 5 + * @format int32 */ total_steps?: number; }; @@ -7306,6 +7309,7 @@ export interface components { /** * @description The hostname for the domain * @example app.example.com + * @pattern ^((xn--)?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,}\.?$ */ domain: string; /** @@ -7323,7 +7327,6 @@ export interface components { */ wildcard?: boolean; /** - * Format: hostname * @description Optional. If the domain uses DigitalOcean DNS and you would like App * Platform to automatically manage it for you, set this to the name of the * domain on your account. @@ -7331,6 +7334,7 @@ export interface components { * For example, If the domain you are adding is `app.domain.com`, the zone * could be `domain.com`. * @example example.com + * @format hostname */ zone?: string; /** @@ -7452,6 +7456,7 @@ export interface components { /** * @description The variable name * @example BASE_URL + * @pattern ^[_A-Za-z][_A-Za-z0-9]*$ */ key: string; /** @@ -7545,7 +7550,10 @@ export interface components { }; /** Configurations for external logging. */ app_log_destination_definition: { - /** @example my_log_destination */ + /** + * @example my_log_destination + * @pattern ^[A-Za-z0-9()\[\]'"][-A-Za-z0-9_. \/()\[\]]{0,40}[A-Za-z0-9()\[\]'"]$ + */ name: string; papertrail?: components["schemas"]["app_log_destination_papertrail_spec"]; datadog?: components["schemas"]["app_log_destination_datadog_spec"]; @@ -7556,6 +7564,7 @@ export interface components { /** * @description The name. Must be unique across all components within the same app. * @example api + * @pattern ^[a-z][a-z0-9-]{0,30}[a-z0-9]$ */ name?: string; git?: components["schemas"]["apps_git_source_spec"]; @@ -7595,10 +7604,10 @@ export interface components { }; app_component_instance_base: { /** - * Format: int64 * @description The amount of instances that this component should be scaled to. Default: 1. Must not be set if autoscaling is used. * @default 1 * @example 2 + * @format int64 */ instance_count: number; /** @@ -7609,15 +7618,15 @@ export interface components { /** @description Configuration for automatically scaling this component based on metrics. */ autoscaling?: { /** - * Format: uint32 * @description The minimum amount of instances for this component. Must be less than max_instance_count. * @example 2 + * @format uint32 */ min_instance_count?: number; /** - * Format: uint32 * @description The maximum amount of instances for this component. Must be more than min_instance_count. * @example 3 + * @format uint32 */ max_instance_count?: number; /** @description The metrics that the component is scaled on. */ @@ -7625,10 +7634,10 @@ export interface components { /** @description Settings for scaling the component based on CPU utilization. */ cpu?: { /** - * Format: uint32 * @description The average target CPU utilization for the component. * @default 80 * @example 75 + * @format uint32 */ percent: number; }; @@ -7707,15 +7716,15 @@ export interface components { }; app_service_spec_health_check: { /** - * Format: int32 * @description The number of failed health checks before considered unhealthy. * @example 2 + * @format int32 */ failure_threshold?: number; /** - * Format: int64 * @description The port on which the health check will be performed. If not set, the health check will be performed on the component's http_port. * @example 80 + * @format int64 */ port?: number; /** @@ -7724,27 +7733,27 @@ export interface components { */ http_path?: string; /** - * Format: int32 * @description The number of seconds to wait before beginning health checks. * @example 30 + * @format int32 */ initial_delay_seconds?: number; /** - * Format: int32 * @description The number of seconds to wait between health checks. * @example 60 + * @format int32 */ period_seconds?: number; /** - * Format: int32 * @description The number of successful health checks before considered healthy. * @example 3 + * @format int32 */ success_threshold?: number; /** - * Format: int32 * @description The number of seconds after which the check times out. * @example 45 + * @format int32 */ timeout_seconds?: number; }; @@ -7763,15 +7772,15 @@ export interface components { }; app_service_spec_termination: { /** - * Format: int32 * @description The number of seconds to wait between selecting a container instance for termination and issuing the TERM signal. Selecting a container instance for termination begins an asynchronous drain of new requests on upstream load-balancers. (Default 15) * @example 15 + * @format int32 */ drain_seconds?: number; /** - * Format: int32 * @description The number of seconds to wait between sending a TERM signal to a container and issuing a KILL which causes immediate shutdown. (Default 120) * @example 120 + * @format int32 */ grace_period_seconds?: number; }; @@ -7788,10 +7797,10 @@ export interface components { */ protocol?: "HTTP" | "HTTP2"; /** - * Format: int64 * @description The internal port on which this service's run command will listen. Default: 8080 * If there is not an environment variable with the name `PORT`, one will be automatically added with its value set to the value of this field. * @example 3000 + * @format int64 */ http_port?: number; /** @@ -7841,9 +7850,9 @@ export interface components { }; app_job_spec_termination: { /** - * Format: int32 * @description The number of seconds to wait between sending a TERM signal to a container and issuing a KILL which causes immediate shutdown. (Default 120) * @example 120 + * @format int32 */ grace_period_seconds?: number; }; @@ -7862,9 +7871,9 @@ export interface components { }; app_worker_spec_termination: { /** - * Format: int32 * @description The number of seconds to wait between sending a TERM signal to a container and issuing a KILL which causes immediate shutdown. (Default 120) * @example 120 + * @format int32 */ grace_period_seconds?: number; }; @@ -7898,9 +7907,9 @@ export interface components { disabled?: boolean; operator?: components["schemas"]["app_alert_spec_operator"]; /** - * Format: float * @description Threshold value for alert * @example 2.32 + * @format float */ value?: number; window?: components["schemas"]["app_alert_spec_window"]; @@ -7915,6 +7924,7 @@ export interface components { /** * @description The name. Must be unique across all components within the same app. * @example api + * @pattern ^[a-z][a-z0-9-]{0,30}[a-z0-9]$ */ name: string; /** @@ -7963,6 +7973,7 @@ export interface components { /** * @description The database's name. The name must be unique across all components within the same app and cannot use capital letters. * @example prod-db + * @pattern ^[a-z][a-z0-9-]{0,30}[a-z0-9]$ */ name: string; /** @@ -8019,9 +8030,9 @@ export interface components { */ authority?: string; /** - * Format: int64 * @description The port to redirect to. * @example 443 + * @format int64 */ port?: number; /** @@ -8030,9 +8041,9 @@ export interface components { */ scheme?: string; /** - * Format: int64 * @description The redirect code to use. Defaults to `302`. Supported values are 300, 301, 302, 303, 304, 307, 308. * @example 302 + * @format int64 */ redirect_code?: number; }; @@ -8084,6 +8095,7 @@ export interface components { /** * @description The name of the app. Must be unique across all apps in the same account. * @example web-app-01 + * @pattern ^[a-z][a-z0-9-]{0,30}[a-z0-9]$ */ name: string; /** @@ -8151,8 +8163,8 @@ export interface components { cloned_from?: string; /** * The creation time of the deployment - * Format: date-time * @example 2020-07-28T18:00:00Z + * @format date-time */ created_at?: string; /** @@ -8167,8 +8179,8 @@ export interface components { phase?: components["schemas"]["apps_deployment_phase"]; /** * When the deployment phase was last updated - * Format: date-time * @example 0001-01-01T00:00:00Z + * @format date-time */ phase_last_updated_at?: string; progress?: components["schemas"]["apps_deployment_progress"]; @@ -8184,8 +8196,8 @@ export interface components { readonly tier_slug?: string; /** * When the deployment was last updated - * Format: date-time * @example 2020-07-28T18:00:00Z + * @format date-time */ updated_at?: string; /** Worker components that are part of this deployment */ @@ -8228,8 +8240,8 @@ export interface components { readonly rotate_validation_records?: boolean; /** * Current SSL certificate expiration time - * Format: date-time * @example 2024-01-29T23:59:59Z + * @format date-time */ readonly certificate_expires_at?: string; }; @@ -8303,8 +8315,8 @@ export interface components { active_deployment?: components["schemas"]["apps_deployment"]; /** * The creation time of the app - * Format: date-time * @example 2020-11-19T20:27:18Z + * @format date-time */ readonly created_at?: string; /** @@ -8322,8 +8334,8 @@ export interface components { in_progress_deployment?: components["schemas"]["apps_deployment"]; /** * The creation time of the last deployment - * Format: date-time * @example 2020-11-19T20:27:18Z + * @format date-time */ readonly last_deployment_created_at?: string; /** @@ -8361,8 +8373,8 @@ export interface components { readonly tier_slug?: string; /** * Time of the app's last configuration update - * Format: date-time * @example 2020-12-01T00:42:16Z + * @format date-time */ readonly updated_at?: string; pinned_deployment?: unknown & components["schemas"]["apps_deployment"]; @@ -8448,15 +8460,15 @@ export interface components { apps_instance_size: { /** * The bandwidth allowance in GiB for the instance size - * Format: int64 * @example 1 + * @format int64 */ bandwidth_allowance_gib?: string; cpu_type?: components["schemas"]["instance_size_cpu_type"]; /** * The number of allotted vCPU cores - * Format: int64 * @example 3 + * @format int64 */ cpus?: string; /** @@ -8466,8 +8478,8 @@ export interface components { deprecation_intent?: boolean; /** * The allotted memory in bytes - * Format: int64 * @example 1048 + * @format int64 */ memory_bytes?: string; /** @@ -8520,8 +8532,8 @@ export interface components { }; apps_list_instance_sizes_response: { /** - * Format: float * @example 2.32 + * @format float */ discount_percent?: number; instance_sizes?: components["schemas"]["apps_instance_size"][]; @@ -8563,16 +8575,16 @@ export interface components { existing_static_apps?: string; spec?: components["schemas"]["app_spec"]; /** - * Format: int32 * @description The monthly cost of the proposed app in USD. * @example 5 + * @format int32 */ app_cost?: number; /** - * Format: int32 * @deprecated * @description The monthly cost of the proposed app in USD using the previous pricing plan tier. For example, if you propose an app that uses the Professional tier, the `app_tier_downgrade_cost` field displays the monthly cost of the app if it were to use the Basic tier. If the proposed app already uses the lest expensive tier, the field is empty. * @example 17 + * @format int32 */ app_tier_downgrade_cost?: number; }; @@ -8626,14 +8638,14 @@ export interface components { status?: components["schemas"]["app_alert_progress_step_status"]; /** * The start time of this step - * Format: date-time * @example 2020-11-19T20:27:18Z + * @format date-time */ started_at?: string; /** * The start time of this step - * Format: date-time * @example 2020-11-19T20:27:18Z + * @format date-time */ ended_at?: string; reason?: components["schemas"]["app_alert_progress_step_reason"]; @@ -8732,9 +8744,9 @@ export interface components { */ app_id?: string; /** - * Format: uint64 * @description The used bandwidth amount in bytes. * @example 513668 + * @format uint64 */ bandwidth_bytes?: string; }; @@ -8742,9 +8754,9 @@ export interface components { /** @description A list of bandwidth usage details by app. */ app_bandwidth_usage?: components["schemas"]["app_metrics_bandwidth_usage_details"][]; /** - * Format: date-time * @description The date for the metrics data. * @example 2023-01-17T00:00:00Z + * @format date-time */ date?: string; }; @@ -8758,29 +8770,29 @@ export interface components { */ app_ids: string[]; /** - * Format: date-time * @description Optional day to query. Only the date component of the timestamp will be considered. Default: yesterday. * @example 2023-01-17T00:00:00Z + * @format date-time */ date?: string; }; cdn_endpoint: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference a CDN endpoint. * @example 892071a0-bb95-49bc-8021-3afd67a210bf + * @format uuid */ readonly id?: string; /** - * Format: hostname * @description The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space. * @example static-images.nyc3.digitaloceanspaces.com + * @format hostname */ origin: string; /** - * Format: hostname * @description The fully qualified domain name (FQDN) from which the CDN-backed content is served. * @example static-images.nyc3.cdn.digitaloceanspaces.com + * @format hostname */ readonly endpoint?: string; /** @@ -8791,21 +8803,21 @@ export interface components { */ ttl: 60 | 600 | 3600 | 86400 | 604800; /** - * Format: uuid * @description The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided. * @example 892071a0-bb95-49bc-8021-3afd67a210bf + * @format uuid */ certificate_id?: string; /** - * Format: hostname * @description The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint. * @example static.example.com + * @format hostname */ custom_domain?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created. * @example 2018-03-21T16:02:37Z + * @format date-time */ readonly created_at?: string; }; @@ -8818,15 +8830,15 @@ export interface components { */ ttl: 60 | 600 | 3600 | 86400 | 604800; /** - * Format: uuid * @description The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided. * @example 892071a0-bb95-49bc-8021-3afd67a210bf + * @format uuid */ certificate_id?: string; /** - * Format: hostname * @description The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint. * @example static.example.com + * @format hostname */ custom_domain?: string; }; @@ -8842,9 +8854,9 @@ export interface components { }; certificate: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference a certificate. * @example 892071a0-bb95-49bc-8021-3afd67a210bf + * @format uuid */ readonly id?: string; /** @@ -8853,9 +8865,9 @@ export interface components { */ name?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents the certificate's expiration date. * @example 2017-02-22T00:23:00Z + * @format date-time */ readonly not_after?: string; /** @@ -8864,9 +8876,9 @@ export interface components { */ readonly sha1_fingerprint?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the certificate was created. * @example 2017-02-08T16:02:37Z + * @format date-time */ readonly created_at?: string; /** @@ -9061,9 +9073,9 @@ export interface components { */ month_to_date_usage?: string; /** - * Format: date-time * @description The time at which balances were most recently generated. * @example 2019-07-09T15:01:12Z + * @format date-time */ generated_at?: string; }; @@ -9089,9 +9101,9 @@ export interface components { */ invoice_uuid?: string; /** - * Format: date-time * @description Time the billing history entry occurred. * @example 2018-06-01T08:44:38Z + * @format date-time */ date?: string; /** @@ -9368,11 +9380,13 @@ export interface components { }; database_version_availability: { /** + * @nullable * @description A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline. * @example 2023-11-09T00:00:00Z */ end_of_life?: string | null; /** + * @nullable * @description A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline. * @example 2023-05-09T00:00:00Z */ @@ -9612,6 +9626,7 @@ export interface components { mysql_settings?: components["schemas"]["mysql_settings"]; settings?: components["schemas"]["user_settings"]; }; + /** @nullable */ database_maintenance_window: { /** * @description The day of the week on which to apply maintenance updates. @@ -9641,11 +9656,13 @@ export interface components { /** * @description A unique ID for the firewall rule itself. * @example 79f26d28-ea8a-41f2-8ad8-8cfcdd020095 + * @pattern ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12} */ uuid?: string; /** * @description A unique ID for the database cluster to which the rule is applied. * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @pattern ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12} */ readonly cluster_uuid?: string; /** @@ -9660,9 +9677,9 @@ export interface components { */ value: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the firewall rule was created. * @example 2019-01-11T18:37:36Z + * @format date-time */ readonly created_at?: string; }; @@ -9680,9 +9697,9 @@ export interface components { }; database_cluster: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference a database cluster. * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @format uuid */ readonly id?: string; /** @@ -9728,17 +9745,19 @@ export interface components { */ readonly status?: "creating" | "online" | "resizing" | "migrating" | "forking"; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the database cluster was created. * @example 2019-01-11T18:37:36Z + * @format date-time */ readonly created_at?: string; /** * @description A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region. * @example d455e75d-4858-4eec-8c95-da2f0a5f93a7 + * @pattern ^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12} */ private_network_uuid?: string; /** + * @nullable * @description An array of tags that have been applied to the database cluster. * @example [ * "production" @@ -9746,6 +9765,7 @@ export interface components { */ tags?: string[] | null; /** + * @nullable * @description An array of strings containing the names of databases created in the database cluster. * @example [ * "doadmin" @@ -9758,12 +9778,13 @@ export interface components { private_connection?: components["schemas"]["database_connection"] & unknown; standby_connection?: components["schemas"]["database_connection"] & unknown; standby_private_connection?: components["schemas"]["database_connection"] & unknown; + /** @nullable */ readonly users?: components["schemas"]["database_user"][] | null; maintenance_window?: components["schemas"]["database_maintenance_window"] & unknown; /** - * Format: uuid * @description The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project. * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @format uuid */ project_id?: string; rules?: components["schemas"]["firewall_rule"][]; @@ -9792,9 +9813,9 @@ export interface components { */ database_name: string; /** - * Format: date-time * @description The timestamp of an existing database cluster backup in ISO8601 combined date and time format. The most recent backup will be used if excluded. * @example 2019-01-31T19:25:22Z + * @format date-time */ backup_created_at?: string; }; @@ -9812,6 +9833,7 @@ export interface components { /** * @description Global SQL mode. If empty, uses MySQL server defaults. Must only include uppercase alphabetic characters, underscores, and commas. * @example ANSI,TRADITIONAL + * @pattern ^[A-Z_]*(,[A-Z_]+)*$ */ sql_mode?: string; /** @@ -9842,6 +9864,7 @@ export interface components { /** * @description The InnoDB FULLTEXT index stopword list for all InnoDB tables. * @example db_name/table_name + * @pattern ^.+/.+$ */ innodb_ft_server_stopword_table?: string; /** @@ -10219,6 +10242,7 @@ export interface components { /** * @description Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters. * @example myrolename + * @pattern ^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$ */ "pg_partman_bgw.role"?: string; /** @@ -10384,6 +10408,7 @@ export interface components { * - `A` — Alias for `"g$lshztxed"` * @default * @example K + * @pattern ^[KEg\$lshzxeA]*$ */ redis_notify_keyspace_events: string; /** @@ -10927,9 +10952,9 @@ export interface components { */ size: string; /** - * Format: int32 * @description 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. * @example 3 + * @format int32 */ num_nodes: number; /** @@ -10940,9 +10965,9 @@ export interface components { }; backup: { /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format at which the backup was created. * @example 2019-01-31T19:25:22Z + * @format date-time */ created_at: string; /** @@ -10953,9 +10978,9 @@ export interface components { }; database_replica: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference a database replica. * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @format uuid */ readonly id?: string; /** @@ -10987,9 +11012,9 @@ export interface components { */ tags?: string[]; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the database cluster was created. * @example 2019-01-11T18:37:36Z + * @format date-time */ readonly created_at?: string; /** @@ -11047,9 +11072,9 @@ export interface components { */ mode: string; /** - * Format: int32 * @description The desired size of the PGBouncer connection pool. The maximum allowed size is determined by the size of the cluster's primary node. 25 backend server connections are allowed for every 1GB of RAM. Three are reserved for maintenance. For example, a primary node with 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. * @example 10 + * @format int32 */ size: number; /** @@ -11078,9 +11103,9 @@ export interface components { */ mode: string; /** - * Format: int32 * @description The desired size of the PGBouncer connection pool. The maximum allowed size is determined by the size of the cluster's primary node. 25 backend server connections are allowed for every 1GB of RAM. Three are reserved for maintenance. For example, a primary node with 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. * @example 10 + * @format int32 */ size: number; /** @@ -11212,10 +11237,10 @@ export interface components { */ message_timestamp_type: "create_time" | "log_append_time"; /** - * Format: float * @description The min_cleanable_dirty_ratio specifies the frequency of log compaction (if enabled) in relation to duplicates present in the logs. For example, at 0.5, at most 50% of the log could be duplicates before compaction would begin. * @default 0.5 * @example 0.5 + * @format float */ min_cleanable_dirty_ratio: number; /** @@ -11291,6 +11316,7 @@ export interface components { * @example 0 */ earliest_offset?: number; + /** @nullable */ consumer_groups?: { /** * @description Name of the consumer group. @@ -11422,10 +11448,10 @@ export interface components { */ index_days_max: number; /** - * Format: float * @description Elasticsearch request timeout limit * @default 10 * @example 10 + * @format float */ timeout: number; /** @@ -11452,10 +11478,10 @@ export interface components { */ index_days_max: number; /** - * Format: float * @description Opensearch request timeout limit * @default 10 * @example 10 + * @format float */ timeout: number; /** @@ -11532,9 +11558,9 @@ export interface components { */ size?: number; /** - * Format: date-time * @description The date and time the index was created. * @example 2021-01-01T00:00:00Z + * @format date-time */ created_time?: string; }; @@ -11564,11 +11590,13 @@ export interface components { */ ip_address?: string; /** + * @nullable * @description This value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested. * @example 1800 */ readonly ttl?: number | null; /** + * @nullable * @description This attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource. * @example $ORIGIN example.com. * $TTL 1800 @@ -11602,11 +11630,13 @@ export interface components { */ data?: string; /** + * @nullable * @description The priority for SRV and MX records. * @example null */ priority?: number | null; /** + * @nullable * @description The port for SRV records. * @example null */ @@ -11617,16 +11647,19 @@ export interface components { */ ttl?: number; /** + * @nullable * @description The weight for SRV records. * @example null */ weight?: number | null; /** + * @nullable * @description An unsigned integer between 0-255 used for CAA records. * @example null */ flags?: number | null; /** + * @nullable * @description The parameter tag for CAA records. Valid values are "issue", "issuewild", or "iodef" * @example null */ @@ -11663,6 +11696,7 @@ export interface components { }; /** * @deprecated + * @nullable * @description **Note**: All Droplets created after March 2017 use internal kernels by default. * These Droplets will have this attribute set to `null`. * @@ -11687,17 +11721,18 @@ export interface components { */ version?: string; } | null; + /** @nullable */ droplet_next_backup_window: { /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window. * @example 2019-12-04T00:00:00Z + * @format date-time */ start?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window. * @example 2019-12-04T23:00:00Z + * @format date-time */ end?: string; } | null; @@ -11732,6 +11767,7 @@ export interface components { */ image_description: string; /** + * @nullable * @description A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. * @example [ * "base-image", @@ -11754,6 +11790,7 @@ export interface components { type?: "base" | "snapshot" | "backup" | "custom" | "admin"; distribution?: components["schemas"]["distribution"]; /** + * @nullable * @description A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id. * @example nifty1 */ @@ -11765,20 +11802,22 @@ export interface components { public?: boolean; regions?: components["schemas"]["regions_array"]; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the image was created. * @example 2020-05-04T22:23:02Z + * @format date-time */ created_at?: string; /** + * @nullable * @description The minimum disk size in GB required for a Droplet to use this image. * @example 20 */ min_disk_size?: number | null; /** - * Format: float + * @nullable * @description The size of the image in gigabytes. * @example 2.34 + * @format float */ size_gigabytes?: number | null; description?: components["schemas"]["image_description"]; @@ -11844,21 +11883,21 @@ export interface components { */ disk: number; /** - * Format: float * @description The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes. * @example 1 + * @format float */ transfer: number; /** - * Format: float * @description This attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars. * @example 5 + * @format float */ price_monthly: number; /** - * Format: float * @description This describes the price of the Droplet size as measured hourly. The value is measured in US dollars. * @example 0.00743999984115362 + * @format float */ price_hourly: number; /** @@ -11897,15 +11936,15 @@ export interface components { }; network_v4: { /** - * Format: ipv4 * @description The IP address of the IPv4 network interface. * @example 104.236.32.182 + * @format ipv4 */ ip_address?: string; /** - * Format: ipv4 * @description The netmask of the IPv4 network interface. * @example 255.255.192.0 + * @format ipv4 */ netmask?: string; /** @@ -11925,9 +11964,9 @@ export interface components { }; network_v6: { /** - * Format: ipv6 * @description The IP address of the IPv6 network interface. * @example 2604:a880:0:1010::18a:a001 + * @format ipv6 */ ip_address?: string; /** @@ -11936,9 +11975,9 @@ export interface components { */ netmask?: number; /** - * Format: ipv6 * @description The gateway of the specified IPv6 network interface. * @example 2604:a880:0:1010::1 + * @format ipv6 */ gateway?: string; /** @@ -11991,9 +12030,9 @@ export interface components { status: "new" | "active" | "off" | "archive"; kernel?: components["schemas"]["kernel"]; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the Droplet was created. * @example 2020-07-21T18:37:44Z + * @format date-time */ created_at: string; /** @@ -12130,6 +12169,7 @@ export interface components { */ monitoring: boolean; /** + * @nullable * @description A flat array of tag names as strings to apply to the Droplet after it is created. Tag names can either be existing or new tags. * @default [] * @example [ @@ -12176,6 +12216,7 @@ export interface components { /** * @description The human-readable string you wish to use when displaying the Droplet name. The name, if set to a domain name managed in the DigitalOcean DNS management system, will configure a PTR record for the Droplet. The name set during creation will also determine the hostname for the Droplet in its internal configuration. * @example example.com + * @pattern ^[a-zA-Z0-9]?[a-z0-9A-Z.\-]*[a-z0-9A-Z]$ */ name: string; } & components["schemas"]["droplet_create"]; @@ -12203,9 +12244,9 @@ export interface components { */ rel?: string; /** - * Format: uri * @description A URL that can be used to access the action. * @example https://api.digitalocean.com/v2/actions/7515 + * @format uri */ href?: string; }; @@ -12216,9 +12257,9 @@ export interface components { */ name: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the snapshot was created. * @example 2020-07-28T16:47:44Z + * @format date-time */ created_at: string; /** @@ -12235,9 +12276,9 @@ export interface components { */ min_disk_size: number; /** - * Format: float * @description The billable size of the snapshot in gigabytes. * @example 2.34 + * @format float */ size_gigabytes: number; }; @@ -12399,6 +12440,7 @@ export interface components { type: "snapshot"; }; /** + * @nullable * @description A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request. * @example [ * "base-image", @@ -12452,9 +12494,11 @@ export interface components { tags?: components["schemas"]["existing_tags_array"] & unknown; }; firewall_rules: { + /** @nullable */ inbound_rules?: (components["schemas"]["firewall_rule_base"] & { sources: components["schemas"]["firewall_rule_target"] & unknown; })[] | null; + /** @nullable */ outbound_rules?: (components["schemas"]["firewall_rule_base"] & { destinations: components["schemas"]["firewall_rule_target"] & unknown; })[] | null; @@ -12472,9 +12516,9 @@ export interface components { */ readonly status?: "waiting" | "succeeded" | "failed"; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the firewall was created. * @example 2020-05-23T21:24:00Z + * @format date-time */ readonly created_at?: string; /** @@ -12498,9 +12542,11 @@ export interface components { /** * @description A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). * @example firewall + * @pattern ^[a-zA-Z0-9][a-zA-Z0-9\.-]+$ */ name?: string; /** + * @nullable * @description An array containing the IDs of the Droplets assigned to the firewall. * @example [ * 8043964 @@ -12579,9 +12625,9 @@ export interface components { */ name?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format indicating when the resource was destroyed if the request was successful. * @example 2020-04-01T18:11:49Z + * @format date-time */ destroyed_at?: string; /** @@ -12602,9 +12648,9 @@ export interface components { volume_snapshots?: components["schemas"]["destroyed_associated_resource"][]; }; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format indicating when the requested action was completed. * @example 2020-04-01T18:11:49Z + * @format date-time */ completed_at?: string; /** @@ -12633,15 +12679,15 @@ export interface components { */ max_instances: number; /** - * Format: float * @description Target CPU utilization as a decimal. * @example 0.6 + * @format float */ target_cpu_utilization?: number; /** - * Format: float * @description Target memory utilization as a decimal. * @example 0.6 + * @format float */ target_memory_utilization?: number; /** @@ -12716,15 +12762,15 @@ export interface components { }; current_utilization: { /** - * Format: float * @description The average memory utilization of the autoscale pool. * @example 0.3588531587713522 + * @format float */ memory?: number; /** - * Format: float * @description The average CPU utilization of the autoscale pool. * @example 0.0007338008770232183 + * @format float */ cpu?: number; }; @@ -12745,16 +12791,16 @@ export interface components { current_utilization?: components["schemas"]["current_utilization"]; /** * The creation time of the autoscale pool - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the autoscale pool was created. * @example 2020-07-28T18:00:00Z + * @format date-time */ created_at: string; /** * When the autoscale pool was last updated - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the autoscale pool was last updated. * @example 2020-07-28T18:00:00Z + * @format date-time */ updated_at: string; /** @@ -12781,15 +12827,15 @@ export interface components { }; member_current_utilization: { /** - * Format: float * @description The memory utilization average of the individual Droplet. * @example 0.3588531587713522 + * @format float */ memory?: number; /** - * Format: float * @description The CPU utilization average of the individual Droplet. * @example 0.0007338008770232183 + * @format float */ cpu?: number; }; @@ -12800,15 +12846,15 @@ export interface components { */ droplet_id: number; /** - * Format: date-time * @description The creation time of the Droplet in ISO8601 combined date and time format. * @example 2020-07-28T18:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The last updated time of the Droplet in ISO8601 combined date and time format. * @example 2020-07-28T18:00:00Z + * @format date-time */ updated_at: string; /** @@ -12853,23 +12899,23 @@ export interface components { */ status: "in_progress" | "success" | "error"; /** - * Format: date-time * @description The creation time of the history event in ISO8601 combined date and time format. * @example 2020-07-28T18:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The last updated time of the history event in ISO8601 combined date and time format. * @example 2020-07-28T18:00:00Z + * @format date-time */ updated_at: string; }; floating_ip: { /** - * Format: ipv4 * @description The public IP address of the floating IP. It also serves as its identifier. * @example 45.55.96.47 + * @format ipv4 */ ip?: string; region?: components["schemas"]["region"] & Record; @@ -12884,9 +12930,9 @@ export interface components { */ locked?: boolean; /** - * Format: uuid * @description The UUID of the project to which the reserved IP currently belongs. * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + * @format uuid */ project_id?: string; }; @@ -12903,9 +12949,9 @@ export interface components { */ region: string; /** - * Format: uuid * @description The UUID of the project to which the floating IP will be assigned. * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + * @format uuid */ project_id?: string; }; @@ -12998,7 +13044,10 @@ export interface components { * @example * * * * * */ cron: string; - /** @description Optional data to be sent to function while triggering the function. */ + /** + * @nullable + * @description Optional data to be sent to function while triggering the function. + */ body?: { /** @example Welcome to DO! */ name?: string; @@ -13043,11 +13092,13 @@ export interface components { scheduled_details?: components["schemas"]["scheduled_details"]; scheduled_runs?: { /** + * @nullable * @description Indicates last run time. null value indicates trigger not run yet. * @example 2022-11-11T04:16:45Z */ last_run_at?: string | null; /** + * @nullable * @description Indicates next run time. null value indicates trigger will not run. * @example 2022-11-11T04:16:45Z */ @@ -13150,9 +13201,9 @@ export interface components { }; node: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference the node. * @example e78247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f + * @format uuid */ id?: string; /** @@ -13175,23 +13226,23 @@ export interface components { */ droplet_id?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the node was created. * @example 2018-11-15T16:00:11Z + * @format date-time */ created_at?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the node was last updated. * @example 2018-11-15T16:00:11Z + * @format date-time */ updated_at?: string; }; kubernetes_node_pool_base: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference a specific node pool. * @example cdda885e-7663-40c8-bc74-3a036c66545d + * @format uuid */ readonly id?: string; /** @@ -13216,6 +13267,7 @@ export interface components { */ tags?: string[]; /** + * @nullable * @description An object of key/value mappings specifying labels to apply to all nodes in a pool. Labels will automatically be applied to all existing nodes and any subsequent nodes added to the pool. Note that when a label is removed, it is not deleted from the nodes in the pool. * @example null */ @@ -13241,7 +13293,10 @@ export interface components { readonly nodes?: components["schemas"]["node"][]; }; kubernetes_node_pool: WithRequired & WithRequired; - /** @description An object specifying the maintenance window policy for the Kubernetes cluster. */ + /** + * @nullable + * @description An object specifying the maintenance window policy for the Kubernetes cluster. + */ maintenance_policy: { /** * @description The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., `15:00`). @@ -13260,7 +13315,10 @@ export interface components { */ day?: "any" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; } | null; - /** @description An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only). */ + /** + * @nullable + * @description An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only). + */ control_plane_firewall: { /** * @description Indicates whether the control plane firewall is enabled. @@ -13278,9 +13336,9 @@ export interface components { } | null; cluster: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference a Kubernetes cluster. * @example bd5f5959-5e1e-4205-a714-a914373942af + * @format uuid */ readonly id?: string; /** @@ -13299,21 +13357,21 @@ export interface components { */ version: string; /** - * Format: cidr * @description The range of IP addresses for the overlay network of the Kubernetes cluster in CIDR notation. * @example 192.168.0.0/20 + * @format cidr */ cluster_subnet?: string; /** - * Format: cidr * @description The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation. * @example 192.168.16.0/24 + * @format cidr */ service_subnet?: string; /** - * Format: uuid * @description A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned. * @example c33931f2-a26a-4e61-b85c-4e95a2ec431b + * @format uuid */ vpc_uuid?: string; /** @@ -13360,15 +13418,15 @@ export interface components { message?: string; }; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created. * @example 2018-11-15T16:00:11Z + * @format date-time */ readonly created_at?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. * @example 2018-11-15T16:00:11Z + * @format date-time */ readonly updated_at?: string; /** @@ -13498,20 +13556,20 @@ export interface components { }; credentials: { /** - * Format: uri * @description The URL used to access the cluster API server. * @example https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com + * @format uri */ server?: string; /** - * Format: byte * @description A base64 encoding of bytes representing the certificate authority data for accessing the cluster. * @example LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURKekNDQWcrZ0F3SUJBZ0lDQm5Vd0RRWUpLb1pJaHZjTkFRRUxCUUF3TXpFVk1CTUdBMVVFQ2hNTVJHbG4KYVhSaGJFOWpaV0Z1TVJvd0dBWURWUVFERXhGck9ITmhZWE1nUTJ4MWMzUmxjaUJEUVRBZUZ3MHlNREE0TURNeApOVEkxTWpoYUZ3MDBNREE0TURNeE5USTFNamhhTURNeEZUQVRCZ05WQkFvVERFUnBaMmwwWVd4UFkyVmhiakVhCk1CZ0dBMVVFQXhNUmF6aHpZV0Z6SUVOc2RYTjBaWElnUTBFd2dnRWlNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0SUIKRHdBd2dnRUtBb0lCQVFDc21oa2JrSEpUcGhZQlN0R05VVE1ORVZTd2N3bmRtajArelQvcUZaNGsrOVNxUnYrSgpBd0lCaGpBU0JnTlZIUk1CQWY4RUNEQUdBUUgvQWdFQU1CMEdBMVVkRGdRV0JCUlRzazhhZ1hCUnFyZXdlTXJxClhwa3E1NXg5dVRBTkJna3Foa2lHOXcwQkFRc0ZBQU9DQVFFQXB6V2F6bXNqYWxXTEx3ZjVpbWdDblNINDlKcGkKYWkvbzFMdEJvVEpleGdqZzE1ZVppaG5BMUJMc0lWNE9BZGM3UEFsL040L0hlbENrTDVxandjamRnNVdaYnMzYwozcFVUQ0g5bVVwMFg1SVdhT1VKV292Q1hGUlM1R2VKYXlkSDVPUXhqTURzR2N2UlNvZGQrVnQ2MXE3aWdFZ2I1CjBOZ1l5RnRnc2p0MHpJN3hURzZFNnlsOVYvUmFoS3lIQks2eExlM1RnUGU4SXhWa2RwT3QzR0FhSDRaK0pLR3gKYisyMVZia1NnRE1QQTlyR0VKNVZwVXlBV0FEVXZDRVFHV0hmNGpQN2ZGZlc3T050S0JWY3h3YWFjcVBVdUhzWApwRG5DZVR3V1NuUVp6L05xNmQxWUtsMFdtbkwzTEowemJzRVFGbEQ4MkkwL09MY2dZSDVxMklOZHhBPT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo= + * @format byte */ certificate_authority_data?: string; /** - * Format: byte * @deprecated + * @nullable * @description A base64 encoding of bytes representing the x509 client * certificate data for access the cluster. This is only returned for clusters * without support for token-based authentication. @@ -13520,11 +13578,12 @@ export interface components { * certificate-based authentication. For additional information, * [see here](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/#authenticate). * @example null + * @format byte */ client_certificate_data?: string | null; /** - * Format: byte * @deprecated + * @nullable * @description A base64 encoding of bytes representing the x509 client key * data for access the cluster. This is only returned for clusters without * support for token-based authentication. @@ -13533,6 +13592,7 @@ export interface components { * certificate-based authentication. For additional information, * [see here](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/#authenticate). * @example null + * @format byte */ client_key_data?: string | null; /** @@ -13541,9 +13601,9 @@ export interface components { */ token?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the access token expires. * @example 2019-11-09T11:50:28.889080521Z + * @format date-time */ expires_at?: string; }; @@ -13572,9 +13632,9 @@ export interface components { user: { kubernetes_cluster_user?: { /** - * Format: email * @description The username for the cluster admin user. * @example sammy@digitalocean.com + * @format email */ username?: string; /** @@ -13624,15 +13684,15 @@ export interface components { */ run_id?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was made. * @example 2019-10-30T05:34:07Z + * @format date-time */ requested_at?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was completed. * @example 2019-10-30T05:34:11Z + * @format date-time */ completed_at?: string; /** @description An array of diagnostics reporting potential problems for the given cluster. */ @@ -13895,9 +13955,9 @@ export interface components { }; load_balancer_base: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @format uuid */ readonly id?: string; /** @@ -13913,6 +13973,7 @@ export interface components { /** * @description An attribute containing the public-facing IP address of the load balancer. * @example 104.131.186.241 + * @pattern ^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ */ readonly ip?: string; /** @@ -13949,9 +14010,9 @@ export interface components { */ readonly status?: "new" | "active" | "errored"; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the load balancer was created. * @example 2017-02-01T22:22:58Z + * @format date-time */ readonly created_at?: string; /** @description An array of objects specifying the forwarding rules for a load balancer. */ @@ -13983,9 +14044,9 @@ export interface components { */ http_idle_timeout_seconds: number; /** - * Format: uuid * @description A string specifying the UUID of the VPC to which the load balancer is assigned. * @example c33931f2-a26a-4e61-b85c-4e95a2ec431b + * @format uuid */ vpc_uuid?: string; /** @@ -14113,8 +14174,8 @@ export interface components { /** @example 78b3da62-27e5-49ba-ac70-5db0b5935c64 */ uuid: string; /** - * Format: float * @example 80 + * @format float */ value: number; /** @@ -14155,8 +14216,8 @@ export interface components { */ type: "v1/insights/droplet/load_1" | "v1/insights/droplet/load_5" | "v1/insights/droplet/load_15" | "v1/insights/droplet/memory_utilization_percent" | "v1/insights/droplet/disk_utilization_percent" | "v1/insights/droplet/cpu" | "v1/insights/droplet/disk_read" | "v1/insights/droplet/disk_write" | "v1/insights/droplet/public_outbound_bandwidth" | "v1/insights/droplet/public_inbound_bandwidth" | "v1/insights/droplet/private_outbound_bandwidth" | "v1/insights/droplet/private_inbound_bandwidth" | "v1/insights/lbaas/avg_cpu_utilization_percent" | "v1/insights/lbaas/connection_utilization_percent" | "v1/insights/lbaas/droplet_health" | "v1/insights/lbaas/tls_connections_per_second_utilization_percent" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_4xx" | "v1/insights/lbaas/high_http_request_response_time" | "v1/insights/lbaas/high_http_request_response_time_50p" | "v1/insights/lbaas/high_http_request_response_time_95p" | "v1/insights/lbaas/high_http_request_response_time_99p" | "v1/dbaas/alerts/load_15_alerts" | "v1/dbaas/alerts/memory_utilization_alerts" | "v1/dbaas/alerts/disk_utilization_alerts" | "v1/dbaas/alerts/cpu_alerts" | "v1/droplet/autoscale_alerts/current_instances" | "v1/droplet/autoscale_alerts/target_instances" | "v1/droplet/autoscale_alerts/current_cpu_utilization" | "v1/droplet/autoscale_alerts/target_cpu_utilization" | "v1/droplet/autoscale_alerts/current_memory_utilization" | "v1/droplet/autoscale_alerts/target_memory_utilization" | "v1/droplet/autoscale_alerts/scale_up" | "v1/droplet/autoscale_alerts/scale_down"; /** - * Format: float * @example 80 + * @format float */ value: number; /** @@ -14313,6 +14374,7 @@ export interface components { /** * @description The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. * @example do:droplet:13457723 + * @pattern ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.* */ urn: string; opensearch_config: { @@ -14378,6 +14440,7 @@ export interface components { /** * @description The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. * @example do:kubernetes:f453aa14-646e-4cf8-8c62-75a19fb24ec2 + * @pattern ^do:kubernetes:.* */ urn: string; /** @@ -14393,9 +14456,9 @@ export interface components { }; project_base: { /** - * Format: uuid * @description The unique universal identifier of this project. * @example 4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679 + * @format uuid */ readonly id?: string; /** @@ -14444,15 +14507,15 @@ export interface components { */ environment?: "Development" | "Staging" | "Production"; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the project was created. * @example 2018-09-27T20:10:35Z + * @format date-time */ readonly created_at?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the project was updated. * @example 2018-09-27T20:10:35Z + * @format date-time */ readonly updated_at?: string; }; @@ -14466,17 +14529,17 @@ export interface components { resource: { urn?: components["schemas"]["urn"]; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the project was created. * @example 2018-09-28T19:26:37Z + * @format date-time */ assigned_at?: string; /** @description The links object contains the `self` object, which contains the resource relationship. */ links?: { /** - * Format: uri * @description A URI that can be used to retrieve the resource. * @example https://api.digitalocean.com/v2/droplets/13457723 + * @format uri */ self?: string; }; @@ -14541,15 +14604,15 @@ export interface components { subscription: { tier?: components["schemas"]["subscription_tier_base"]; /** - * Format: date-time * @description The time at which the subscription was created. * @example 2020-01-23T21:19:12Z + * @format date-time */ readonly created_at?: string; /** - * Format: date-time * @description The time at which the subscription was last updated. * @example 2020-11-05T15:53:24Z + * @format date-time */ readonly updated_at?: string; }; @@ -14557,12 +14620,13 @@ export interface components { /** * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. * @example example + * @pattern ^[a-z0-9-]{1,63}$ */ name?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format that represents when the registry was created. * @example 2020-03-21T16:02:37Z + * @format date-time */ readonly created_at?: string; /** @@ -14576,9 +14640,9 @@ export interface components { */ readonly storage_usage_bytes?: number; /** - * Format: date-time * @description The time at which the storage usage was updated. Storage usage is calculated asynchronously, and may not immediately reflect pushes to the registry. * @example 2020-11-04T21:39:49.530562231Z + * @format date-time */ readonly storage_usage_bytes_updated_at?: string; subscription?: unknown & components["schemas"]["subscription"]; @@ -14587,6 +14651,7 @@ export interface components { /** * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. * @example example + * @pattern ^[a-z0-9-]{1,63}$ */ name: string; /** @@ -14617,6 +14682,7 @@ export interface components { /** * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. * @example example + * @pattern ^[a-z0-9-]{1,63}$ */ name: string; }; @@ -14652,9 +14718,9 @@ export interface components { */ size_bytes?: number; /** - * Format: date-time * @description The time the tag was last updated. * @example 2020-04-09T23:54:25Z + * @format date-time */ updated_at?: string; }; @@ -14715,9 +14781,9 @@ export interface components { */ size_bytes?: number; /** - * Format: date-time * @description The time the manifest was last updated. * @example 2020-04-09T23:54:25Z + * @format date-time */ updated_at?: string; /** @@ -14773,15 +14839,15 @@ export interface components { */ status?: "requested" | "waiting for write JWTs to expire" | "scanning manifests" | "deleting unreferenced blobs" | "cancelling" | "failed" | "succeeded" | "cancelled"; /** - * Format: date-time * @description The time the garbage collection was created. * @example 2020-10-30T21:03:24Z + * @format date-time */ created_at?: string; /** - * Format: date-time * @description The time the garbage collection was last updated. * @example 2020-10-30T21:03:44Z + * @format date-time */ updated_at?: string; /** @@ -14835,9 +14901,9 @@ export interface components { }; reserved_ip: { /** - * Format: ipv4 * @description The public IP address of the reserved IP. It also serves as its identifier. * @example 45.55.96.47 + * @format ipv4 */ ip?: string; region?: components["schemas"]["region"] & Record; @@ -14852,9 +14918,9 @@ export interface components { */ locked?: boolean; /** - * Format: uuid * @description The UUID of the project to which the reserved IP currently belongs. * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + * @format uuid */ project_id?: string; }; @@ -14871,9 +14937,9 @@ export interface components { */ region: string; /** - * Format: uuid * @description The UUID of the project to which the reserved IP will be assigned. * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + * @format uuid */ project_id?: string; }; @@ -14923,6 +14989,7 @@ export interface components { */ resource_type: "droplet" | "volume"; /** + * @nullable * @description An array of Tags the snapshot has been tagged with. * @example [ * "web", @@ -14959,6 +15026,7 @@ export interface components { * * Tagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named "PROD", you can tag resources in the control panel by entering "prod". The tag will still display with its canonical capitalization, "PROD". * @example extra-awesome + * @pattern ^[a-zA-Z0-9_\-\:]+$ */ name?: string; /** @@ -15003,6 +15071,7 @@ export interface components { */ error: string; /** + * @nullable * @description A list of error messages. * @example null */ @@ -15052,6 +15121,7 @@ export interface components { */ readonly id?: string; /** + * @nullable * @description An array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet. * @example [] */ @@ -15174,7 +15244,10 @@ export interface components { * @example attach_volume */ type?: string; - /** @example null */ + /** + * @nullable + * @example null + */ resource_id?: number | null; } & components["schemas"]["action"]; volume_action_post_resize: components["schemas"]["volume_action_post_base"] & { @@ -15185,6 +15258,7 @@ export interface components { /** * @description The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods. * @example env.prod-vpc + * @pattern ^[a-zA-Z0-9\-\.]+$ */ name?: string; /** @@ -15214,16 +15288,16 @@ export interface components { }; vpc_base: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference the VPC. * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @format uuid */ readonly id?: string; urn?: components["schemas"]["urn"]; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format. * @example 2020-03-13T19:20:47.442049222Z + * @format date-time */ readonly created_at?: string; }; @@ -15243,15 +15317,15 @@ export interface components { }; vpc_peering_base: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference the VPC peering. * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @format uuid */ readonly id?: string; /** - * Format: date-time * @description A time value given in ISO8601 combined date and time format. * @example 2020-03-13T19:20:47.442049222Z + * @format date-time */ readonly created_at?: string; /** @@ -15275,15 +15349,16 @@ export interface components { /** * @description The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. * @example nyc1-blr1-peering + * @pattern ^[a-zA-Z0-9\-]+$ */ name?: string; }; vpc_peering: components["schemas"]["vpc_peering_base"] & components["schemas"]["vpc_peering_create"] & components["schemas"]["vpc_peering_updatable"]; check_base: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference the check. * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @format uuid */ readonly id?: string; }; @@ -15300,9 +15375,9 @@ export interface components { */ type?: "ping" | "http" | "https"; /** - * Format: url * @description The endpoint to perform healthchecks on. * @example https://www.landingpage.com + * @format url */ target?: string; /** @@ -15353,9 +15428,9 @@ export interface components { }; alert_base: { /** - * Format: uuid * @description A unique ID that can be used to identify and reference the alert. * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @format uuid */ readonly id?: string; }; @@ -15371,15 +15446,15 @@ export interface components { /** @description Slack integration details. */ slack: { /** - * Format: string * @description Slack channel to notify of an alert trigger. * @example Production Alerts + * @format string */ channel: string; /** - * Format: string * @description Slack Webhook URL. * @example https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ + * @format string */ url: string; }[]; @@ -15462,9 +15537,9 @@ export interface components { /** @description Description of deployment */ apiDeployment: { /** - * Format: date-time * @description Creation date / time * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** @@ -15474,9 +15549,9 @@ export interface components { name?: string; status?: components["schemas"]["apiDeploymentStatus"]; /** - * Format: date-time * @description Last modified * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -15511,21 +15586,21 @@ export interface components { /** @description Version Information about a Model */ apiModelVersion: { /** - * Format: int64 * @description Major version number * @example 123 + * @format int64 */ major?: number; /** - * Format: int64 * @description Minor version number * @example 123 + * @format int64 */ minor?: number; /** - * Format: int64 * @description Patch version number * @example 123 + * @format int64 */ patch?: number; }; @@ -15533,9 +15608,9 @@ export interface components { apiModel: { agreement?: components["schemas"]["apiAgreement"]; /** - * Format: date-time * @description Creation date / time * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** @@ -15567,9 +15642,9 @@ export interface components { parent_uuid?: string; provider?: components["schemas"]["apiModelProvider"]; /** - * Format: date-time * @description Last modified * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -15598,15 +15673,15 @@ export interface components { /** @description IndexingJob description */ apiIndexingJob: { /** - * Format: int64 * @description Number of datasources indexed completed * @example 123 + * @format int64 */ completed_datasources?: number; /** - * Format: date-time * @description Creation date / time * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** @@ -15616,8 +15691,8 @@ export interface components { */ data_source_uuids?: string[]; /** - * Format: date-time * @example 2023-01-01T00:00:00Z + * @format date-time */ finished_at?: string; /** @@ -15627,26 +15702,26 @@ export interface components { knowledge_base_uuid?: string; phase?: components["schemas"]["apiBatchJobPhase"]; /** - * Format: date-time * @example 2023-01-01T00:00:00Z + * @format date-time */ started_at?: string; /** - * Format: int64 * @description Number of tokens * @example 123 + * @format int64 */ tokens?: number; /** - * Format: int64 * @description Number of datasources being indexed * @example 123 + * @format int64 */ total_datasources?: number; /** - * Format: date-time * @description Last modified * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -15658,15 +15733,15 @@ export interface components { /** @description Knowledgebase Description */ apiKnowledgeBase: { /** - * Format: date-time * @description Time when the knowledge base was added to the agent * @example 2023-01-01T00:00:00Z + * @format date-time */ added_to_agent_at?: string; /** - * Format: date-time * @description Creation date / time * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** @example "123e4567-e89b-12d3-a456-426614174000" */ @@ -15699,15 +15774,15 @@ export interface components { */ tags?: string[]; /** - * Format: date-time * @description Last modified * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** - * Format: int64 * @description Id of user that created the knowledge base * @example "12345" + * @format int64 */ user_id?: string; /** @@ -15719,9 +15794,9 @@ export interface components { /** @description Represents an AgentTemplate entity */ apiAgentTemplate: { /** - * Format: date-time * @description The agent template's creation date * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** @@ -15735,17 +15810,17 @@ export interface components { */ instruction?: string; /** - * Format: int64 * @description The 'k' value for the agent template * @example 123 + * @format int64 */ k?: number; /** @description List of knowledge bases associated with the agent template */ knowledge_bases?: components["schemas"]["apiKnowledgeBase"][]; /** - * Format: int64 * @description The max_tokens setting for the agent template * @example 123 + * @format int64 */ max_tokens?: number; model?: components["schemas"]["apiModel"]; @@ -15755,21 +15830,21 @@ export interface components { */ name?: string; /** - * Format: float * @description The temperature setting for the agent template * @example 123 + * @format float */ temperature?: number; /** - * Format: float * @description The top_p setting for the agent template * @example 123 + * @format float */ top_p?: number; /** - * Format: date-time * @description The agent template's last updated date * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -15784,9 +15859,9 @@ export interface components { /** @description Chatbot identifiers */ chatbot_identifiers?: components["schemas"]["apiAgentChatbotIdentifier"][]; /** - * Format: date-time * @description Creation date / time * @example 2021-01-01T00:00:00Z + * @format date-time */ created_at?: string; deployment?: components["schemas"]["apiDeployment"]; @@ -15806,15 +15881,15 @@ export interface components { */ instruction?: string; /** - * Format: int64 * @description How many results should be considered from an attached knowledge base * @example 5 + * @format int64 */ k?: number; /** - * Format: int64 * @description Specifies the maximum number of tokens the model can process in a single input or output, set as a number between 1 and 512. This determines the length of each response. * @example 100 + * @format int64 */ max_tokens?: number; model?: components["schemas"]["apiModel"]; @@ -15834,15 +15909,15 @@ export interface components { */ region?: string; /** - * Format: date-time * @description Creation of route date / time * @example 2021-01-01T00:00:00Z + * @format date-time */ route_created_at?: string; /** - * Format: uint64 * @description Id of user that created the route * @example 12345678 + * @format uint64 */ route_created_by?: string; /** @@ -15863,22 +15938,22 @@ export interface components { */ tags?: string[]; /** - * Format: float * @description Controls the model’s creativity, specified as a number between 0 and 1. Lower values produce more predictable and conservative responses, while higher values encourage creativity and variation. * @example 0.5 + * @format float */ temperature?: number; template?: components["schemas"]["apiAgentTemplate"]; /** - * Format: float * @description Defines the cumulative probability threshold for word selection, specified as a number between 0 and 1. Higher values allow for more diverse outputs, while lower values ensure focused and coherent responses. * @example 0.9 + * @format float */ top_p?: number; /** - * Format: date-time * @description Last modified * @example 2021-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -15887,9 +15962,9 @@ export interface components { */ url?: string; /** - * Format: uint64 * @description Id of user that created the agent * @example 12345678 + * @format uint64 */ user_id?: string; /** @@ -15928,21 +16003,21 @@ export interface components { /** @description Meta information about the data set */ apiMeta: { /** - * Format: int64 * @description The current page * @example 123 + * @format int64 */ page?: number; /** - * Format: int64 * @description Total number of pages * @example 123 + * @format int64 */ pages?: number; /** - * Format: int64 * @description Total amount of items over all pages * @example 123 + * @format int64 */ total?: number; }; @@ -16003,21 +16078,21 @@ export interface components { /** @description Anthropic API Key Info */ apiAnthropicAPIKeyInfo: { /** - * Format: date-time * @description Key creation date * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** - * Format: uint64 * @description Created by user id from DO * @example "12345" + * @format uint64 */ created_by?: string; /** - * Format: date-time * @description Key deleted date * @example 2023-01-01T00:00:00Z + * @format date-time */ deleted_at?: string; /** @@ -16026,9 +16101,9 @@ export interface components { */ name?: string; /** - * Format: date-time * @description Key last updated date * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -16040,21 +16115,21 @@ export interface components { /** @description Agent API Key Info */ apiAgentAPIKeyInfo: { /** - * Format: date-time * @description Creation date * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** - * Format: uint64 * @description Created by * @example "12345" + * @format uint64 */ created_by?: string; /** - * Format: date-time * @description Deleted date * @example 2023-01-01T00:00:00Z + * @format date-time */ deleted_at?: string; /** @@ -16091,9 +16166,9 @@ export interface components { /** @description Child agents */ child_agents?: components["schemas"]["apiAgent"][]; /** - * Format: date-time * @description Creation date / time * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; deployment?: components["schemas"]["apiDeployment"]; @@ -16113,15 +16188,15 @@ export interface components { */ instruction?: string; /** - * Format: int64 * @example 123 + * @format int64 */ k?: number; /** @description Knowledge bases */ knowledge_bases?: components["schemas"]["apiKnowledgeBase"][]; /** - * Format: int64 * @example 123 + * @format int64 */ max_tokens?: number; model?: components["schemas"]["apiModel"]; @@ -16140,14 +16215,14 @@ export interface components { */ region?: string; /** - * Format: date-time * @description Creation of route date / time * @example 2023-01-01T00:00:00Z + * @format date-time */ route_created_at?: string; /** - * Format: uint64 * @example "12345" + * @format uint64 */ route_created_by?: string; /** @@ -16165,20 +16240,20 @@ export interface components { */ tags?: string[]; /** - * Format: float * @example 123 + * @format float */ temperature?: number; template?: components["schemas"]["apiAgentTemplate"]; /** - * Format: float * @example 123 + * @format float */ top_p?: number; /** - * Format: date-time * @description Last modified * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -16187,9 +16262,9 @@ export interface components { */ url?: string; /** - * Format: uint64 * @description Id of user that created the agent * @example "12345" + * @format uint64 */ user_id?: string; /** @@ -16206,9 +16281,9 @@ export interface components { */ api_key?: string; /** - * Format: date-time * @description Creation date / time * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** @@ -16228,9 +16303,9 @@ export interface components { name?: string; output_schema?: Record; /** - * Format: date-time * @description Last modified * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -16255,8 +16330,8 @@ export interface components { /** @example "123e4567-e89b-12d3-a456-426614174000" */ agent_uuid?: string; /** - * Format: date-time * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** @example "example string" */ @@ -16273,14 +16348,14 @@ export interface components { /** @example "example name" */ name?: string; /** - * Format: int32 * @example 123 + * @format int32 */ priority?: number; type?: components["schemas"]["apiGuardrailType"]; /** - * Format: date-time * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @example "123e4567-e89b-12d3-a456-426614174000" */ @@ -16535,15 +16610,15 @@ export interface components { */ instruction?: string; /** - * Format: int64 * @description How many results should be considered from an attached knowledge base * @example 5 + * @format int64 */ k?: number; /** - * Format: int64 * @description Specifies the maximum number of tokens the model can process in a single input or output, set as a number between 1 and 512. This determines the length of each response. * @example 100 + * @format int64 */ max_tokens?: number; /** @@ -16569,15 +16644,15 @@ export interface components { */ tags?: string[]; /** - * Format: float * @description Controls the model’s creativity, specified as a number between 0 and 1. Lower values produce more predictable and conservative responses, while higher values encourage creativity and variation. * @example 0.7 + * @format float */ temperature?: number; /** - * Format: float * @description Defines the cumulative probability threshold for word selection, specified as a number between 0 and 1. Higher values allow for more diverse outputs, while lower values ensure focused and coherent responses. * @example 0.9 + * @format float */ top_p?: number; /** @@ -16640,9 +16715,9 @@ export interface components { }; apiIndexedDataSource: { /** - * Format: date-time * @description Timestamp when data source completed indexing * @example 2023-01-01T00:00:00Z + * @format date-time */ completed_at?: string; /** @@ -16651,33 +16726,33 @@ export interface components { */ data_source_uuid?: string; /** - * Format: uint64 * @description Total count of files that have been indexed * @example "12345" + * @format uint64 */ indexed_file_count?: string; /** - * Format: date-time * @description Timestamp when data source started indexing * @example 2023-01-01T00:00:00Z + * @format date-time */ started_at?: string; /** - * Format: uint64 * @description Total size of files in data source in bytes * @example "12345" + * @format uint64 */ total_bytes?: string; /** - * Format: uint64 * @description Total size of files in data source in bytes that have been indexed * @example "12345" + * @format uint64 */ total_bytes_indexed?: string; /** - * Format: uint64 * @description Total file count in the data source * @example "12345" + * @format uint64 */ total_file_count?: string; }; @@ -16715,9 +16790,9 @@ export interface components { */ original_file_name?: string; /** - * Format: uint64 * @description The size of the file in bytes * @example "12345" + * @format uint64 */ size_in_bytes?: string; /** @@ -16813,9 +16888,9 @@ export interface components { */ bucket_name?: string; /** - * Format: date-time * @description Creation date / time * @example 2023-01-01T00:00:00Z + * @format date-time */ created_at?: string; file_upload_data_source?: components["schemas"]["apiFileUploadDataSource"]; @@ -16832,9 +16907,9 @@ export interface components { region?: string; spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; /** - * Format: date-time * @description Last modified * @example 2023-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -16939,9 +17014,9 @@ export interface components { apiModelPublic: { agreement?: components["schemas"]["apiAgreement"]; /** - * Format: date-time * @description Creation date / time * @example 2021-01-01T00:00:00Z + * @format date-time */ created_at?: string; /** @@ -16960,9 +17035,9 @@ export interface components { */ parent_uuid?: string; /** - * Format: date-time * @description Last modified * @example 2021-01-01T00:00:00Z + * @format date-time */ updated_at?: string; /** @@ -20390,9 +20465,9 @@ export interface components { "application/json": { action?: components["schemas"]["action"] & { /** - * Format: uuid * @description The UUID of the project to which the reserved IP currently belongs. * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + * @format uuid */ project_id?: string; }; @@ -21057,6 +21132,7 @@ export interface components { }; content: { "application/json": { + /** @nullable */ available_upgrade_versions?: components["schemas"]["kubernetes_version"][] | null; }; }; @@ -21900,9 +21976,9 @@ export interface components { "application/json": { action?: components["schemas"]["action"] & { /** - * Format: uuid * @description The UUID of the project to which the reserved IP currently belongs. * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + * @format uuid */ project_id?: string; }; @@ -33081,12 +33157,13 @@ export interface operations { /** * @description The name of the VPC peering. Must be unique and may only contain alphanumeric characters, dashes, and periods. * @example nyc1-blr1-peering + * @pattern ^[a-zA-Z0-9\-\.]+$ */ name: string; /** - * Format: uuid * @description The ID of the VPC to peer with. * @example c140286f-e6ce-4131-8b7b-df4590ce8d6a + * @format uuid */ vpc_id: string; }; diff --git a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts index 4ccd073d1..54a0f7eca 100644 --- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts @@ -18417,74 +18417,74 @@ export type webhooks = Record; export type components = { schemas: { readonly root: { - /** Format: uri-template */ + /** @format uri-template */ readonly current_user_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly current_user_authorizations_html_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly authorizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly code_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commit_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly emails_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly emojis_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly feeds_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly followers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url: string; /** - * Format: uri-template * @deprecated + * @format uri-template */ readonly hub_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly label_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly organization_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly organization_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly organization_teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly public_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly rate_limit_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly repository_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly repository_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly current_user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly topic_search_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly user_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly user_organizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly user_search_url: string; }; /** @@ -18494,34 +18494,67 @@ export type components = { readonly "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ readonly vulnerability: { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range: string | null; - /** @description The package version that resolves the vulnerability. */ + /** + * @nullable + * @description The package version that resolves the vulnerability. + */ readonly first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ + /** + * @nullable + * @description The functions in the package that are affected by the vulnerability. + */ readonly vulnerable_functions: readonly string[] | null; }; + /** @nullable */ readonly "cvss-severities": { + /** @nullable */ readonly cvss_v3?: { - /** @description The CVSS 3 vector string. */ + /** + * @nullable + * @description The CVSS 3 vector string. + */ readonly vector_string: string | null; - /** @description The CVSS 3 score. */ + /** + * @nullable + * @description The CVSS 3 score. + */ readonly score: number | null; } | null; + /** @nullable */ readonly cvss_v4?: { - /** @description The CVSS 4 vector string. */ + /** + * @nullable + * @description The CVSS 4 vector string. + */ readonly vector_string: string | null; - /** @description The CVSS 4 score. */ + /** + * @nullable + * @description The CVSS 4 score. + */ readonly score: number | null; } | null; } | null; - /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + /** + * @nullable + * @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). + */ readonly "security-advisory-epss": { readonly percentage?: number; readonly percentile?: number; @@ -18531,37 +18564,42 @@ export type components = { * @description A GitHub user. */ readonly "simple-user": { + /** @nullable */ readonly name?: string | null; + /** @nullable */ readonly email?: string | null; /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -18571,25 +18609,25 @@ export type components = { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -18609,23 +18647,30 @@ export type components = { readonly "global-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id: string | null; /** @description The API URL for the advisory. */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The API URL for the repository advisory. + * @format uri */ readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ readonly summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ readonly description: string | null; /** * @description The type of advisory. @@ -18638,10 +18683,12 @@ export type components = { */ readonly severity: "critical" | "high" | "medium" | "low" | "unknown"; /** - * Format: uri + * @nullable * @description The URL of the advisory's source code. + * @format uri */ readonly source_code_location: string | null; + /** @nullable */ readonly identifiers: readonly { /** * @description The type of identifier. @@ -18651,50 +18698,68 @@ export type components = { /** @description The identifier value. */ readonly value: string; }[] | null; + /** @nullable */ readonly references: readonly string[] | null; /** - * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + * @format date-time */ readonly github_reviewed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. * This field is only populated when the advisory is imported from the National Vulnerability Database. + * @format date-time */ readonly nvd_published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; - /** @description The products and respective version ranges affected by the advisory. */ + /** + * @nullable + * @description The products and respective version ranges affected by the advisory. + */ readonly vulnerabilities: readonly components["schemas"]["vulnerability"][] | null; + /** @nullable */ readonly cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ readonly vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; readonly cvss_severities?: components["schemas"]["cvss-severities"]; readonly epss?: components["schemas"]["security-advisory-epss"]; + /** @nullable */ readonly cwes: readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ readonly cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description The users who contributed to the advisory. */ + /** + * @nullable + * @description The users who contributed to the advisory. + */ readonly credits: readonly { readonly user: components["schemas"]["simple-user"]; readonly type: components["schemas"]["security-advisory-credit-types"]; @@ -18724,16 +18789,20 @@ export type components = { * @description An enterprise on GitHub. */ readonly enterprise: { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ readonly description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ readonly website_url?: string | null; /** @@ -18754,20 +18823,23 @@ export type components = { */ readonly slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; }; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly integration: { @@ -18791,26 +18863,29 @@ export type components = { * @example Probot Owners */ readonly name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ readonly description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ readonly external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ readonly html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ readonly updated_at: string; /** @@ -18844,15 +18919,18 @@ export type components = { readonly installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ readonly client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ readonly webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ readonly pem?: string; } | null; /** - * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook + * @format uri */ readonly "webhook-config-url": string; /** @@ -18892,9 +18970,9 @@ export type components = { */ readonly guid: string; /** - * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z + * @format date-time */ readonly delivered_at: string; /** @@ -18923,24 +19001,28 @@ export type components = { */ readonly event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ readonly action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ readonly installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ readonly repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ readonly throttled_at?: string | null; }; @@ -18949,10 +19031,14 @@ export type components = { * @description Scim Error */ readonly "scim-error": { + /** @nullable */ readonly message?: string | null; + /** @nullable */ readonly documentation_url?: string | null; + /** @nullable */ readonly detail?: string | null; readonly status?: number; + /** @nullable */ readonly scimType?: string | null; readonly schemas?: readonly string[]; }; @@ -18988,9 +19074,9 @@ export type components = { */ readonly guid: string; /** - * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z + * @format date-time */ readonly delivered_at: string; /** @@ -19019,24 +19105,28 @@ export type components = { */ readonly event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ readonly action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ readonly installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ readonly repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ readonly throttled_at?: string | null; /** @@ -19045,21 +19135,33 @@ export type components = { */ readonly url?: string; readonly request: { - /** @description The request headers sent with the webhook delivery. */ + /** + * @nullable + * @description The request headers sent with the webhook delivery. + */ readonly headers: { readonly [key: string]: unknown; } | null; - /** @description The webhook payload. */ + /** + * @nullable + * @description The webhook payload. + */ readonly payload: { readonly [key: string]: unknown; } | null; }; readonly response: { - /** @description The response headers received when the delivery was made. */ + /** + * @nullable + * @description The response headers received when the delivery was made. + */ readonly headers: { readonly [key: string]: unknown; } | null; - /** @description The response payload received. */ + /** + * @nullable + * @description The response payload received. + */ readonly payload: string | null; }; }; @@ -19078,8 +19180,8 @@ export type components = { readonly account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; readonly requester: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-07-08T16:18:44-04:00 + * @format date-time */ readonly created_at: string; }; @@ -19337,40 +19439,46 @@ export type components = { }; /** * Simple User + * @nullable * @description A GitHub user. */ readonly "nullable-simple-user": { + /** @nullable */ readonly name?: string | null; + /** @nullable */ readonly email?: string | null; /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -19380,25 +19488,25 @@ export type components = { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -19419,6 +19527,7 @@ export type components = { * @example 1 */ readonly id: number; + /** @nullable */ readonly account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -19426,18 +19535,18 @@ export type components = { */ readonly repository_selection: "all" | "selected"; /** - * Format: uri * @example https://api.github.com/app/installations/1/access_tokens + * @format uri */ readonly access_tokens_url: string; /** - * Format: uri * @example https://api.github.com/installation/repositories + * @format uri */ readonly repositories_url: string; /** - * Format: uri * @example https://github.com/organizations/github/settings/installations/1 + * @format uri */ readonly html_url: string; /** @example 1 */ @@ -19448,11 +19557,14 @@ export type components = { readonly target_type: string; readonly permissions: components["schemas"]["app-permissions"]; readonly events: readonly string[]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ readonly single_file_name: string | null; /** @example true */ readonly has_multiple_single_files?: boolean; @@ -19466,13 +19578,20 @@ export type components = { /** @example github-actions */ readonly app_slug: string; readonly suspended_by: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly suspended_at: string | null; - /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ + /** + * @nullable + * @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" + */ readonly contact_email?: string | null; }; /** * License Simple + * @nullable * @description License Simple */ readonly "nullable-license-simple": { @@ -19481,15 +19600,19 @@ export type components = { /** @example MIT License */ readonly name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ readonly url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ readonly spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; } | null; /** @@ -19498,9 +19621,9 @@ export type components = { */ readonly repository: { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -19528,16 +19651,19 @@ export type components = { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -19559,28 +19685,28 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -19602,13 +19728,13 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -19622,30 +19748,30 @@ export type components = { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -19653,25 +19779,28 @@ export type components = { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -19743,18 +19872,21 @@ export type components = { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -19872,7 +20004,10 @@ export type components = { */ readonly single_file_paths?: readonly string[]; }; - /** Scoped Installation */ + /** + * Scoped Installation + * @nullable + */ readonly "nullable-scoped-installation": { readonly permissions: components["schemas"]["app-permissions"]; /** @@ -19880,7 +20015,10 @@ export type components = { * @enum {string} */ readonly repository_selection: "all" | "selected"; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ readonly single_file_name: string | null; /** @example true */ readonly has_multiple_single_files?: boolean; @@ -19892,8 +20030,8 @@ export type components = { */ readonly single_file_paths?: readonly string[]; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repositories_url: string; readonly account: components["schemas"]["simple-user"]; @@ -19903,32 +20041,45 @@ export type components = { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ readonly authorization: { - /** Format: int64 */ + /** @format int64 */ readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** @description A list of scopes that this authorization is in. */ + /** + * @nullable + * @description A list of scopes that this authorization is in. + */ readonly scopes: readonly string[] | null; readonly token: string; + /** @nullable */ readonly token_last_eight: string | null; + /** @nullable */ readonly hashed_token: string | null; readonly app: { readonly client_id: string; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; + /** @nullable */ readonly note: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly note_url: string | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; + /** @nullable */ readonly fingerprint: string | null; readonly user?: components["schemas"]["nullable-simple-user"]; readonly installation?: components["schemas"]["nullable-scoped-installation"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly expires_at: string | null; }; /** @@ -19947,9 +20098,9 @@ export type components = { */ readonly full_name: string; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; /** @@ -19977,11 +20128,14 @@ export type components = { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/github + * @format uri */ readonly html_url: string; - /** @example Github - Code thigns happen here */ + /** + * @nullable + * @example Github - Code thigns happen here + */ readonly name: string | null; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; @@ -20065,11 +20219,13 @@ export type components = { */ readonly feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ readonly max_teams: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20100,9 +20256,10 @@ export type components = { */ readonly language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly deadline: string | null; readonly starter_code_repository: components["schemas"]["simple-classroom-repository"]; @@ -20118,13 +20275,13 @@ export type components = { /** @example octocat */ readonly login: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; }; @@ -20206,11 +20363,13 @@ export type components = { */ readonly feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ readonly max_teams?: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20241,9 +20400,10 @@ export type components = { */ readonly language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly deadline: string | null; readonly classroom: components["schemas"]["simple-classroom"]; @@ -20320,8 +20480,8 @@ export type components = { /** @example Contributor Covenant */ readonly name: string; /** - * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant + * @format uri */ readonly url: string; /** @@ -20372,7 +20532,10 @@ export type components = { * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). */ readonly body?: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; }; /** @description A code security configuration */ @@ -20423,14 +20586,21 @@ export type components = { * @enum {string} */ readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ readonly code_scanning_default_setup_options?: { /** + * @nullable * @description Whether to use labeled runners or standard GitHub runners. * @enum {string|null} */ readonly runner_type?: "standard" | "labeled" | "not_set" | null; - /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning when runner_type is 'labeled'. + */ readonly runner_label?: string | null; } | null; /** @@ -20482,28 +20652,34 @@ export type components = { */ readonly enforcement?: "enforced" | "unenforced"; /** - * Format: uri * @description The URL of the configuration + * @format uri */ readonly url?: string; /** - * Format: uri * @description The URL of the configuration + * @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; }; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ readonly "code-scanning-default-setup-options": { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ readonly runner_type?: "standard" | "labeled" | "not_set"; - /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. + */ readonly runner_label?: string | null; } | null; /** @description A list of default code security configurations */ @@ -20521,9 +20697,9 @@ export type components = { */ readonly "simple-repository": { /** - * Format: int64 * @description A unique identifier of the repository. * @example 1296269 + * @format int64 */ readonly id: number; /** @@ -20545,12 +20721,13 @@ export type components = { /** @description Whether the repository is private. */ readonly private: boolean; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; /** + * @nullable * @description The repository description. * @example This your first repo! */ @@ -20558,9 +20735,9 @@ export type components = { /** @description Whether the repository is a fork. */ readonly fork: boolean; /** - * Format: uri * @description The URL to get more information about the repository from the GitHub API. * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @@ -20609,33 +20786,33 @@ export type components = { */ readonly contents_url: string; /** - * Format: uri * @description A template for the API URL to list the contributors to the repository. * @example https://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @description The API URL to list the deployments of the repository. * @example https://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @description The API URL to list the downloads on the repository. * @example https://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @description The API URL to list the events of the repository. * @example https://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @description The API URL to list the forks of the repository. * @example https://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @@ -20679,15 +20856,15 @@ export type components = { */ readonly labels_url: string; /** - * Format: uri * @description The API URL to get information about the languages of the repository. * @example https://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @description The API URL to merge branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @@ -20711,9 +20888,9 @@ export type components = { */ readonly releases_url: string; /** - * Format: uri * @description The API URL to list the stargazers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @@ -20722,27 +20899,27 @@ export type components = { */ readonly statuses_url: string; /** - * Format: uri * @description The API URL to list the subscribers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @description The API URL to subscribe to notifications for this repository. * @example https://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @description The API URL to get information about tags on the repository. * @example https://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @description The API URL to list the teams on the repository. * @example https://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @@ -20751,9 +20928,9 @@ export type components = { */ readonly trees_url: string; /** - * Format: uri * @description The API URL to list the hooks on the repository. * @example https://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; }; @@ -20785,7 +20962,10 @@ export type components = { readonly severity: "low" | "medium" | "high" | "critical"; /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ + /** + * @nullable + * @description Details pertaining to the package version that patches this vulnerability. + */ readonly first_patched_version: { /** @description The package version that patches this vulnerability. */ readonly identifier: string; @@ -20795,7 +20975,10 @@ export type components = { readonly "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ + /** + * @nullable + * @description The unique CVE ID assigned to the advisory. + */ readonly cve_id: string | null; /** @description A short, plain text summary of the advisory. */ readonly summary: string; @@ -20812,7 +20995,10 @@ export type components = { readonly cvss: { /** @description The overall CVSS score of the advisory. */ readonly score: number; - /** @description The full CVSS vector string for the advisory. */ + /** + * @nullable + * @description The full CVSS vector string for the advisory. + */ readonly vector_string: string | null; }; readonly cvss_severities?: components["schemas"]["cvss-severities"]; @@ -20837,60 +21023,64 @@ export type components = { /** @description Links to additional advisory information. */ readonly references: readonly { /** - * Format: uri * @description The URL of the reference. + * @format uri */ readonly url: string; }[]; /** - * Format: date-time * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly withdrawn_at: string | null; }; /** - * Format: uri * @description The REST API URL of the alert resource. + * @format uri */ readonly "alert-url": string; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly "alert-html-url": string; /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-created-at": string; /** - * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-updated-at": string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-dismissed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-fixed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ @@ -20907,6 +21097,7 @@ export type components = { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -20921,19 +21112,24 @@ export type components = { readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; readonly dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ readonly dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ readonly dismissed_comment: string | null; readonly fixed_at: components["schemas"]["alert-fixed-at"]; readonly auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; readonly repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time + * @nullable * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "nullable-alert-updated-at": string | null; /** @@ -20942,6 +21138,7 @@ export type components = { */ readonly "secret-scanning-alert-state": "open" | "resolved"; /** + * @nullable * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. * @enum {string|null} */ @@ -20953,15 +21150,16 @@ export type components = { readonly url?: components["schemas"]["alert-url"]; readonly html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ readonly locations_url?: string; readonly state?: components["schemas"]["secret-scanning-alert-state"]; readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly resolved_at?: string | null; readonly resolved_by?: components["schemas"]["nullable-simple-user"]; @@ -20975,34 +21173,54 @@ export type components = { /** @description The secret that was detected. */ readonly secret?: string; readonly repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ readonly push_protection_bypassed?: boolean | null; readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly push_protection_bypassed_at?: string | null; readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ readonly push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ readonly push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ readonly push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ + /** + * @nullable + * @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"; - /** @description Whether the secret was publicly leaked. */ + /** + * @nullable + * @description Whether the secret was publicly leaked. + */ readonly publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. + */ readonly multi_repo?: boolean | null; }; /** @@ -21013,30 +21231,32 @@ export type components = { readonly id: number; readonly login: string; readonly display_login?: string; + /** @nullable */ readonly gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; }; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly "nullable-milestone": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ readonly labels_url: string; /** @example 1002604 */ @@ -21060,7 +21280,10 @@ export type components = { * @example v1.0 */ readonly title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ readonly description: string | null; readonly creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -21068,28 +21291,31 @@ export type components = { /** @example 8 */ readonly closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ readonly due_on: string | null; } | null; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly "nullable-integration": { @@ -21113,26 +21339,29 @@ export type components = { * @example Probot Owners */ readonly name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ readonly description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ readonly external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ readonly html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ readonly updated_at: string; /** @@ -21166,7 +21395,10 @@ export type components = { readonly installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ readonly client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ readonly webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ readonly pem?: string; @@ -21180,7 +21412,7 @@ export type components = { readonly "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** Reaction Rollup */ readonly "reaction-rollup": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly total_count: number; readonly "+1": number; @@ -21203,23 +21435,23 @@ export type components = { * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ readonly issue: { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -21232,6 +21464,7 @@ export type components = { */ readonly state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -21243,6 +21476,7 @@ export type components = { */ readonly title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -21256,45 +21490,67 @@ export type components = { * ] */ readonly labels: readonly (string | { - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly name?: string; + /** @nullable */ readonly description?: string | null; + /** @nullable */ readonly color?: string | null; readonly default?: boolean; })[]; readonly assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; readonly milestone: components["schemas"]["nullable-milestone"]; readonly locked: boolean; + /** @nullable */ readonly active_lock_reason?: string | null; readonly comments: number; readonly pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly draft?: boolean; readonly closed_by?: components["schemas"]["nullable-simple-user"]; readonly body_html?: string; readonly body_text?: string; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; readonly repository?: components["schemas"]["repository"]; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21308,16 +21564,16 @@ export type components = { */ readonly "issue-comment": { /** - * Format: int64 * @description Unique identifier of the issue comment * @example 42 + * @format int64 */ readonly id: number; readonly node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ readonly url: string; /** @@ -21327,20 +21583,20 @@ export type components = { readonly body?: string; readonly body_text?: string; readonly body_html?: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly author_association: components["schemas"]["author-association"]; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21352,12 +21608,13 @@ export type components = { */ readonly event: { readonly id: string; + /** @nullable */ readonly type: string | null; readonly actor: components["schemas"]["actor"]; readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly org?: components["schemas"]["actor"]; @@ -21368,6 +21625,7 @@ export type components = { readonly pages?: readonly { readonly page_name?: string; readonly title?: string; + /** @nullable */ readonly summary?: string | null; readonly action?: string; readonly sha?: string; @@ -21375,7 +21633,10 @@ export type components = { }[]; }; readonly public: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; }; /** @@ -21439,19 +21700,19 @@ export type components = { * @description Base Gist */ readonly "base-gist": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly id: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly git_pull_url: string; - /** Format: uri */ + /** @format uri */ readonly git_push_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly files: { readonly [key: string]: { @@ -21468,15 +21729,16 @@ export type components = { }; }; readonly public: boolean; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; + /** @nullable */ readonly description: string | null; readonly comments: number; readonly comments_enabled?: boolean; readonly user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly owner?: components["schemas"]["simple-user"]; readonly truncated?: boolean; @@ -21489,7 +21751,7 @@ export type components = { */ readonly "public-user": { readonly login: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; /** * @description discriminator enum property added by openapi-typescript @@ -21497,47 +21759,61 @@ export type components = { */ readonly user_view_type: "public"; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; + /** @nullable */ readonly gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly followers_url: string; readonly following_url: string; readonly gists_url: string; readonly starred_url: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url: string; - /** Format: uri */ + /** @format uri */ readonly repos_url: string; readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url: string; readonly type: string; readonly site_admin: boolean; + /** @nullable */ readonly name: string | null; + /** @nullable */ readonly company: string | null; + /** @nullable */ readonly blog: string | null; + /** @nullable */ readonly location: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly notification_email?: string | null; + /** @nullable */ readonly hireable: boolean | null; + /** @nullable */ readonly bio: string | null; + /** @nullable */ readonly twitter_username?: string | null; readonly public_repos: number; readonly public_gists: number; readonly followers: number; readonly following: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly plan?: { readonly collaborators: number; @@ -21563,14 +21839,14 @@ export type components = { readonly "gist-history": { readonly user?: components["schemas"]["nullable-simple-user"]; readonly version?: string; - /** Format: date-time */ + /** @format date-time */ readonly committed_at?: string; readonly change_status?: { readonly total?: number; readonly additions?: number; readonly deletions?: number; }; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** @@ -21578,37 +21854,44 @@ export type components = { * @description Gist Simple */ readonly "gist-simple": { - /** @deprecated */ + /** + * @deprecated + * @nullable + */ readonly forks?: readonly { readonly id?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user?: components["schemas"]["public-user"]; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; }[] | null; - /** @deprecated */ + /** + * @deprecated + * @nullable + */ readonly history?: readonly components["schemas"]["gist-history"][] | null; /** * Gist + * @nullable * @description Gist */ readonly fork_of?: { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly id: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly git_pull_url: string; - /** Format: uri */ + /** @format uri */ readonly git_push_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly files: { readonly [key: string]: { @@ -21620,15 +21903,16 @@ export type components = { }; }; readonly public: boolean; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; + /** @nullable */ readonly description: string | null; readonly comments: number; readonly comments_enabled?: boolean; readonly user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly owner?: components["schemas"]["nullable-simple-user"]; readonly truncated?: boolean; @@ -21662,9 +21946,11 @@ export type components = { readonly public?: boolean; readonly created_at?: string; readonly updated_at?: string; + /** @nullable */ readonly description?: string | null; readonly comments?: number; readonly comments_enabled?: boolean; + /** @nullable */ readonly user?: string | null; readonly comments_url?: string; readonly owner?: components["schemas"]["simple-user"]; @@ -21680,8 +21966,8 @@ export type components = { /** @example MDExOkdpc3RDb21tZW50MQ== */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + * @format uri */ readonly url: string; /** @@ -21691,13 +21977,13 @@ export type components = { readonly body: string; readonly user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ readonly updated_at: string; readonly author_association: components["schemas"]["author-association"]; @@ -21708,8 +21994,8 @@ export type components = { */ readonly "gist-commit": { /** - * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + * @format uri */ readonly url: string; /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ @@ -21721,8 +22007,8 @@ export type components = { readonly deletions?: number; }; /** - * Format: date-time * @example 2010-04-14T02:15:15Z + * @format date-time */ readonly committed_at: string; }; @@ -21764,15 +22050,19 @@ export type components = { /** @example MIT License */ readonly name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ readonly url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ readonly spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; }; /** @@ -21784,18 +22074,22 @@ export type components = { readonly key: string; /** @example MIT License */ readonly name: string; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ readonly spdx_id: string | null; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ readonly url: string | null; /** @example MDc6TGljZW5zZW1pdA== */ readonly node_id: string; /** - * Format: uri * @example http://choosealicense.com/licenses/mit/ + * @format uri */ readonly html_url: string; /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ @@ -21857,13 +22151,13 @@ export type components = { */ readonly "marketplace-listing-plan": { /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts + * @format uri */ readonly accounts_url: string; /** @example 1313 */ @@ -21885,6 +22179,7 @@ export type components = { readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; /** @example true */ readonly has_free_trial: boolean; + /** @nullable */ readonly unit_name: string | null; /** @example published */ readonly state: string; @@ -21906,20 +22201,26 @@ export type components = { readonly id: number; readonly login: string; readonly organization_billing_email?: string; + /** @nullable */ readonly email?: string | null; + /** @nullable */ readonly marketplace_pending_change?: { readonly is_installed?: boolean; readonly effective_date?: string; + /** @nullable */ readonly unit_count?: number | null; readonly id?: number; readonly plan?: components["schemas"]["marketplace-listing-plan"]; } | null; readonly marketplace_purchase: { readonly billing_cycle?: string; + /** @nullable */ readonly next_billing_date?: string | null; readonly is_installed?: boolean; + /** @nullable */ readonly unit_count?: number | null; readonly on_free_trial?: boolean; + /** @nullable */ readonly free_trial_ends_on?: string | null; readonly updated_at?: string; readonly plan?: components["schemas"]["marketplace-listing-plan"]; @@ -22043,6 +22344,7 @@ export type components = { }; }; }; + /** @nullable */ readonly "security-and-analysis": { readonly advanced_security?: { /** @enum {string} */ @@ -22079,8 +22381,8 @@ export type components = { */ readonly "minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -22092,16 +22394,19 @@ export type components = { readonly owner: components["schemas"]["simple-user"]; readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -22123,28 +22428,28 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -22165,13 +22470,13 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -22184,43 +22489,46 @@ export type components = { readonly releases_url: string; readonly ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ readonly trees_url: string; readonly clone_url?: string; + /** @nullable */ readonly mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; readonly svn_url?: string; + /** @nullable */ readonly homepage?: string | null; + /** @nullable */ readonly language?: string | null; readonly forks_count?: number; readonly stargazers_count?: number; @@ -22241,18 +22549,21 @@ export type components = { readonly disabled?: boolean; readonly visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at?: string | null; readonly permissions?: { @@ -22269,6 +22580,7 @@ export type components = { readonly subscribers_count?: number; readonly network_count?: number; readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ readonly license?: { readonly key?: string; readonly name?: string; @@ -22303,6 +22615,7 @@ export type components = { readonly reason: string; readonly unread: boolean; readonly updated_at: string; + /** @nullable */ readonly last_read_at: string | null; readonly url: string; /** @example https://api.github.com/notifications/threads/2/subscription */ @@ -22316,25 +22629,27 @@ export type components = { /** @example true */ readonly subscribed: boolean; readonly ignored: boolean; + /** @nullable */ readonly reason: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-06T21:34:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: uri * @example https://api.github.com/notifications/threads/1/subscription + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/notifications/threads/1 + * @format uri */ readonly thread_url?: string; /** - * Format: uri * @example https://api.github.com/repos/1 + * @format uri */ readonly repository_url?: string; }; @@ -22350,18 +22665,18 @@ export type components = { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22374,7 +22689,10 @@ export type components = { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; }; readonly "billing-usage-report": { @@ -22415,18 +22733,18 @@ export type components = { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22439,25 +22757,31 @@ export type components = { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; /** @example github */ readonly name?: string; /** @example GitHub */ readonly company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ readonly blog?: string; /** @example San Francisco */ readonly location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ readonly email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ readonly twitter_username?: string | null; /** @example true */ readonly is_verified?: boolean; @@ -22474,8 +22798,8 @@ export type components = { /** @example 0 */ readonly following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** @example Organization */ @@ -22484,11 +22808,18 @@ export type components = { readonly total_private_repos?: number; /** @example 100 */ readonly owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ readonly private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ readonly disk_usage?: number | null; /** + * @nullable * @description The number of collaborators on private repositories. * * This field may be null if the number of private repositories is over 50,000. @@ -22496,8 +22827,9 @@ export type components = { */ readonly collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ readonly billing_email?: string | null; readonly plan?: { @@ -22507,10 +22839,17 @@ export type components = { readonly filled_seats?: number; readonly seats?: number; }; + /** @nullable */ readonly default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly two_factor_requirement_enabled?: boolean | null; /** @example all */ readonly members_allowed_repository_creation_type?: string; @@ -22526,7 +22865,10 @@ export type components = { readonly members_can_create_public_pages?: boolean; /** @example true */ readonly members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ readonly members_can_fork_private_repositories?: boolean | null; /** @example false */ readonly web_commit_signoff_required?: boolean; @@ -22596,18 +22938,22 @@ export type components = { */ readonly secret_scanning_push_protection_custom_link_enabled?: boolean; /** + * @nullable * @description An optional URL string to display to contributors who are blocked from pushing a secret. * @example https://github.com/test-org/test-repo/blob/main/README.md */ readonly secret_scanning_push_protection_custom_link?: string | null; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly archived_at: string | null; /** * @description Controls whether or not deploy keys may be added and used for repositories in the organization. @@ -22644,6 +22990,7 @@ export type components = { }; /** * GitHub-hosted runner image details. + * @nullable * @description Provides details of a hosted runner image */ readonly "nullable-actions-hosted-runner-pool-image": { @@ -22767,9 +23114,10 @@ export type components = { /** @description The public IP ranges when public IP is enabled for the hosted runners. */ readonly public_ips?: readonly components["schemas"]["public-ip"][]; /** - * Format: date-time + * @nullable * @description The time at which the runner was last used, in ISO 8601 format. * @example 2022-10-09T23:39:01Z + * @format date-time */ readonly last_active_on?: string | null; }; @@ -22981,9 +23329,9 @@ export type components = { */ readonly token: string; /** - * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z + * @format date-time */ readonly expires_at: string; /** @@ -22995,7 +23343,10 @@ export type components = { readonly permissions?: Record; /** @description The repositories this token has access to */ readonly repositories?: readonly components["schemas"]["repository"][]; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ readonly single_file?: string | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -23013,9 +23364,9 @@ export type components = { * @example SECRET_TOKEN */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** * @description Visibility of a secret @@ -23023,8 +23374,8 @@ export type components = { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories + * @format uri */ readonly selected_repositories_url?: string; }; @@ -23068,15 +23419,15 @@ export type components = { */ readonly value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly updated_at: string; /** @@ -23085,14 +23436,17 @@ export type components = { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/variables/USERNAME/repositories + * @format uri */ readonly selected_repositories_url?: string; }; /** @description The name of the tool used to generate the code scanning analysis. */ readonly "code-scanning-analysis-tool-name": string; - /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + /** + * @nullable + * @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. + */ readonly "code-scanning-analysis-tool-guid": string | null; /** * @description State of a code scanning alert. @@ -23105,33 +23459,43 @@ export type components = { */ readonly "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; /** - * Format: uri * @description The REST API URL for fetching the list of instances for an alert. + * @format uri */ readonly "alert-instances-url": string; /** + * @nullable * @description State of a code scanning alert. * @enum {string|null} */ readonly "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** + * @nullable * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ readonly "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; - /** @description The dismissal comment associated with the dismissal of the alert. */ + /** + * @nullable + * @description The dismissal comment associated with the dismissal of the alert. + */ readonly "code-scanning-alert-dismissed-comment": string | null; readonly "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ readonly id?: string | null; /** @description The name of the rule used to detect the alert. */ readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -23140,14 +23504,26 @@ export type components = { readonly description?: string; /** @description A description of the rule used to detect the alert. */ readonly full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ readonly tags?: readonly string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; }; - /** @description The version of the tool used to generate the code scanning analysis. */ + /** + * @nullable + * @description The version of the tool used to generate the code scanning analysis. + */ readonly "code-scanning-analysis-tool-version": string | null; readonly "code-scanning-analysis-tool": { readonly name?: components["schemas"]["code-scanning-analysis-tool-name"]; @@ -23174,6 +23550,7 @@ export type components = { readonly end_column?: number; }; /** + * @nullable * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ @@ -23216,6 +23593,7 @@ export type components = { }; /** * Codespace machine + * @nullable * @description A description of the machine powering a codespace. */ readonly "nullable-codespace-machine": { @@ -23250,6 +23628,7 @@ export type components = { */ readonly cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -23262,8 +23641,8 @@ export type components = { */ readonly codespace: { /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @@ -23272,11 +23651,13 @@ export type components = { */ readonly name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ readonly display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -23286,29 +23667,31 @@ export type components = { readonly repository: components["schemas"]["minimal-repository"]; readonly machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ readonly devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ readonly prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly last_used_at: string; /** @@ -23318,8 +23701,8 @@ export type components = { */ readonly state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ readonly url: string; /** @description Details about the codespace's git repository. */ @@ -23351,63 +23734,81 @@ export type components = { */ readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ readonly idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ readonly web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ readonly machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ readonly start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ readonly stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ readonly publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ readonly pulls_url: string | null; readonly recent_folders: readonly string[]; readonly runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ readonly allowed_port_privacy_settings?: readonly string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ readonly pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ readonly pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ readonly idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ readonly retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ readonly retention_expires_at?: string | null; /** + * @nullable * @description The text to display to a user when a codespace has been stopped for a potentially actionable reason. * @example you've used 100% of your spending limit for Codespaces */ @@ -23424,13 +23825,13 @@ export type components = { */ readonly name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly updated_at: string; /** @@ -23439,9 +23840,9 @@ export type components = { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories + * @format uri */ readonly selected_repositories_url?: string; }; @@ -23528,6 +23929,7 @@ export type components = { }; /** * Organization Simple + * @nullable * @description A GitHub organization. */ readonly "nullable-organization-simple": { @@ -23538,18 +23940,18 @@ export type components = { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -23562,11 +23964,15 @@ export type components = { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; } | null; /** * Team Simple + * @nullable * @description Groups of organization members that gives permissions on specified repositories. */ readonly "nullable-team-simple": { @@ -23578,9 +23984,9 @@ export type components = { /** @example MDQ6VGVhbTE= */ readonly node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ readonly url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -23591,6 +23997,7 @@ export type components = { */ readonly name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -23611,13 +24018,13 @@ export type components = { */ readonly notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ readonly repositories_url: string; /** @example justice-league */ @@ -23637,6 +24044,7 @@ export type components = { readonly node_id: string; readonly name: string; readonly slug: string; + /** @nullable */ readonly description: string | null; readonly privacy?: string; readonly notification_setting?: string; @@ -23648,15 +24056,15 @@ export type components = { readonly maintain: boolean; readonly admin: boolean; }; - /** Format: uri */ + /** @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; readonly members_url: string; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly parent: components["schemas"]["nullable-team-simple"]; }; @@ -23665,27 +24073,33 @@ export type components = { * @description Group of enterprise owners and/or members */ readonly "enterprise-team": { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly name: string; readonly slug: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @example disabled | all */ readonly sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + /** + * @nullable + * @example 62ab9291-fae2-468e-974b-7e45096d5021 + */ readonly group_id?: string | null; - /** @example Justice League */ + /** + * @nullable + * @example Justice League + */ readonly group_name?: string | null; /** - * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league + * @format uri */ readonly html_url: string; readonly members_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -23695,29 +24109,37 @@ export type components = { readonly "copilot-seat-details": { readonly assignee: components["schemas"]["simple-user"]; readonly organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + /** + * @nullable + * @description The team through which the assignee is granted access to GitHub Copilot, if applicable. + */ readonly assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** - * Format: date + * @nullable * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @format date */ readonly pending_cancellation_date?: string | null; /** - * Format: date-time + * @nullable * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @format date-time */ readonly last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + /** + * @nullable + * @description Last editor that was used by the user for a GitHub Copilot completion. + */ readonly last_activity_editor?: string | null; /** - * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @deprecated * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at?: string; /** @@ -23726,7 +24148,10 @@ export type components = { */ readonly plan_type?: "business" | "enterprise" | "unknown"; }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot editor code completions in the IDE. + */ readonly "copilot-ide-code-completions": ({ /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ readonly total_engaged_users?: number; @@ -23748,7 +24173,10 @@ export type components = { readonly name?: string; /** @description Indicates whether a model is custom or default. */ readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ readonly custom_model_training_date?: string | null; /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ readonly total_engaged_users?: number; @@ -23774,7 +24202,10 @@ export type components = { } & { readonly [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in the IDE. + */ readonly "copilot-ide-chat": ({ /** @description Total number of users who prompted Copilot Chat in the IDE. */ readonly total_engaged_users?: number; @@ -23789,7 +24220,10 @@ export type components = { readonly name?: string; /** @description Indicates whether a model is custom or default. */ readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ readonly custom_model_training_date?: string | null; /** @description The number of users who prompted Copilot Chat in the given editor and model. */ readonly total_engaged_users?: number; @@ -23804,7 +24238,10 @@ export type components = { } & { readonly [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in github.com + */ readonly "copilot-dotcom-chat": ({ /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ readonly total_engaged_users?: number; @@ -23814,7 +24251,10 @@ export type components = { readonly name?: string; /** @description Indicates whether a model is custom or default. */ readonly is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ + /** + * @nullable + * @description The training date for the custom model (if applicable). + */ readonly custom_model_training_date?: string | null; /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ readonly total_engaged_users?: number; @@ -23824,7 +24264,10 @@ export type components = { } & { readonly [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot for pull requests. */ + /** + * @nullable + * @description Usage metrics for Copilot for pull requests. + */ readonly "copilot-dotcom-pull-requests": ({ /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ readonly total_engaged_users?: number; @@ -23840,7 +24283,10 @@ export type components = { readonly name?: string; /** @description Indicates whether a model is custom or default. */ readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ readonly custom_model_training_date?: string | null; /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ readonly total_pr_summaries_created?: number; @@ -23857,8 +24303,8 @@ export type components = { */ readonly "copilot-usage-metrics-day": { /** - * Format: date * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @format date */ readonly date: string; /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ @@ -23878,8 +24324,8 @@ export type components = { */ readonly "copilot-usage-metrics": { /** - * Format: date * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @format date */ readonly day: string; /** @description The total number of Copilot code completion suggestions shown to users. */ @@ -23898,7 +24344,10 @@ export type components = { readonly total_chat_turns?: number; /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ readonly total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ + /** + * @nullable + * @description Breakdown of Copilot code completions usage by language and editor + */ readonly breakdown: readonly ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ readonly language?: string; @@ -23928,9 +24377,9 @@ export type components = { * @example SECRET_TOKEN */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** * @description Visibility of a secret @@ -23938,8 +24387,8 @@ export type components = { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories + * @format uri */ readonly selected_repositories_url?: string; }; @@ -23961,12 +24410,13 @@ export type components = { }; /** * Minimal Repository + * @nullable * @description Minimal Repository */ readonly "nullable-minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -23978,16 +24428,19 @@ export type components = { readonly owner: components["schemas"]["simple-user"]; readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -24009,28 +24462,28 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -24051,13 +24504,13 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -24070,43 +24523,46 @@ export type components = { readonly releases_url: string; readonly ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ readonly trees_url: string; readonly clone_url?: string; + /** @nullable */ readonly mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; readonly svn_url?: string; + /** @nullable */ readonly homepage?: string | null; + /** @nullable */ readonly language?: string | null; readonly forks_count?: number; readonly stargazers_count?: number; @@ -24127,18 +24583,21 @@ export type components = { readonly disabled?: boolean; readonly visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at?: string | null; readonly permissions?: { @@ -24155,6 +24614,7 @@ export type components = { readonly subscribers_count?: number; readonly network_count?: number; readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ readonly license?: { readonly key?: string; readonly name?: string; @@ -24209,9 +24669,9 @@ export type components = { readonly visibility: "private" | "public"; readonly owner?: components["schemas"]["nullable-simple-user"]; readonly repository?: components["schemas"]["nullable-minimal-repository"]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -24219,13 +24679,17 @@ export type components = { * @description Organization Invitation */ readonly "organization-invitation": { - /** Format: int64 */ + /** @format int64 */ readonly id: number; + /** @nullable */ readonly login: string | null; + /** @nullable */ readonly email: string | null; readonly role: string; readonly created_at: string; + /** @nullable */ readonly failed_at?: string | null; + /** @nullable */ readonly failed_reason?: string | null; readonly inviter: components["schemas"]["simple-user"]; readonly team_count: number; @@ -24244,18 +24708,18 @@ export type components = { /** @example 1 */ readonly id: number; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings + * @format uri */ readonly ping_url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries + * @format uri */ readonly deliveries_url?: string; /** @example web */ @@ -24280,13 +24744,13 @@ export type components = { readonly secret?: string; }; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ readonly created_at: string; readonly type: string; @@ -24301,15 +24765,16 @@ export type components = { /** @description The API path's route template */ readonly api_route?: string; /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ readonly total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ readonly rate_limited_request_count?: number; + /** @nullable */ readonly last_rate_limited_timestamp?: string | null; readonly last_request_timestamp?: string; }[]; @@ -24320,10 +24785,11 @@ export type components = { readonly "api-insights-subject-stats": readonly { readonly subject_type?: string; readonly subject_name?: string; - /** Format: int64 */ + /** @format int64 */ readonly subject_id?: number; readonly total_request_count?: number; readonly rate_limited_request_count?: number; + /** @nullable */ readonly last_rate_limited_timestamp?: string | null; readonly last_request_timestamp?: string; }[]; @@ -24333,13 +24799,13 @@ export type components = { */ readonly "api-insights-summary-stats": { /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ readonly total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ readonly rate_limited_request_count?: number; }; @@ -24349,9 +24815,9 @@ export type components = { */ readonly "api-insights-time-stats": readonly { readonly timestamp?: string; - /** Format: int64 */ + /** @format int64 */ readonly total_request_count?: number; - /** Format: int64 */ + /** @format int64 */ readonly rate_limited_request_count?: number; }[]; /** @@ -24361,14 +24827,21 @@ export type components = { readonly "api-insights-user-stats": readonly { readonly actor_type?: string; readonly actor_name?: string; - /** Format: int64 */ + /** @format int64 */ readonly actor_id?: number; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ readonly integration_id?: number | null; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ readonly oauth_application_id?: number | null; readonly total_request_count?: number; readonly rate_limited_request_count?: number; + /** @nullable */ readonly last_rate_limited_timestamp?: string | null; readonly last_request_timestamp?: string; }[]; @@ -24387,8 +24860,8 @@ export type components = { /** @example repository */ readonly origin: string; /** - * Format: date-time * @example 2018-08-17T04:18:39Z + * @format date-time */ readonly expires_at: string; }; @@ -24412,8 +24885,8 @@ export type components = { */ readonly "org-membership": { /** - * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt + * @format uri */ readonly url: string; /** @@ -24429,8 +24902,8 @@ export type components = { */ readonly role: "admin" | "member" | "billing_manager"; /** - * Format: uri * @example https://api.github.com/orgs/octocat + * @format uri */ readonly organization_url: string; readonly organization: components["schemas"]["organization-simple"]; @@ -24445,8 +24918,8 @@ export type components = { */ readonly migration: { /** - * Format: int64 * @example 79 + * @format int64 */ readonly id: number; readonly owner: components["schemas"]["nullable-simple-user"]; @@ -24465,22 +24938,22 @@ export type components = { /** @description The repositories included in the migration. Only returned for export migrations. */ readonly repositories: readonly components["schemas"]["repository"][]; /** - * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 + * @format uri */ readonly url: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ readonly updated_at: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly archive_url?: string; /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ readonly exclude?: readonly string[]; @@ -24491,20 +24964,25 @@ export type components = { */ readonly "organization-role": { /** - * Format: int64 * @description The unique identifier of the role. + * @format int64 */ 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. */ + /** + * @nullable + * @description A short description about who this role is for or what permissions it grants. + */ readonly description?: string | null; /** + * @nullable * @description The system role from which this role inherits permissions. * @enum {string|null} */ readonly base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; /** + * @nullable * @description Source answers the question, "where did this role come from?" * @enum {string|null} */ @@ -24513,13 +24991,13 @@ export type components = { readonly permissions: readonly string[]; readonly organization: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @description The date and time the role was created. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time the role was last updated. + * @format date-time */ readonly updated_at: string; }; @@ -24538,6 +25016,7 @@ export type components = { readonly node_id: string; readonly name: string; readonly slug: string; + /** @nullable */ readonly description: string | null; readonly privacy?: string; readonly notification_setting?: string; @@ -24549,15 +25028,15 @@ export type components = { readonly maintain: boolean; readonly admin: boolean; }; - /** Format: uri */ + /** @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; readonly members_url: string; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly parent: components["schemas"]["nullable-team-simple"]; }; @@ -24574,9 +25053,9 @@ export type components = { /** @example MDQ6VGVhbTE= */ readonly node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ readonly url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -24587,6 +25066,7 @@ export type components = { */ readonly name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -24607,13 +25087,13 @@ export type components = { */ readonly notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ readonly repositories_url: string; /** @example justice-league */ @@ -24637,7 +25117,9 @@ export type components = { readonly assignment?: "direct" | "indirect" | "mixed"; /** @description Team the user has gotten the role through */ readonly inherited_from?: readonly components["schemas"]["team-simple"][]; + /** @nullable */ readonly name?: string | null; + /** @nullable */ readonly email?: string | null; /** @example octocat */ readonly login: string; @@ -24646,25 +25128,28 @@ export type components = { /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -24674,25 +25159,25 @@ export type components = { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -24728,18 +25213,18 @@ export type components = { readonly license?: string; readonly description?: string; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly deleted_at?: string; /** Package Version Metadata */ @@ -24766,7 +25251,10 @@ export type components = { readonly "organization-programmatic-access-grant-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */ readonly id: number; - /** @description Reason for requesting access. */ + /** + * @nullable + * @description Reason for requesting access. + */ readonly reason: string | null; readonly owner: components["schemas"]["simple-user"]; /** @@ -24796,9 +25284,15 @@ export type components = { readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ readonly token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ readonly token_last_used_at: string | null; }; /** @@ -24836,9 +25330,15 @@ export type components = { readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ readonly token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ readonly token_last_used_at: string | null; }; /** @@ -24857,6 +25357,7 @@ export type components = { */ readonly registry_type: "maven_repository"; /** + * @nullable * @description The username to use when authenticating with the private registry. * @example monalisa */ @@ -24866,9 +25367,9 @@ export type components = { * @enum {string} */ readonly visibility: "all" | "private" | "selected"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -24898,9 +25399,9 @@ export type components = { readonly visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ readonly selected_repository_ids?: readonly number[]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -24909,23 +25410,23 @@ export type components = { */ readonly project: { /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test + * @format uri */ readonly owner_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604/columns + * @format uri */ readonly columns_url: string; /** @example 1002604 */ @@ -24938,6 +25439,7 @@ export type components = { */ readonly name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -24951,13 +25453,13 @@ export type components = { readonly state: string; readonly creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly updated_at: string; /** @@ -24976,8 +25478,8 @@ export type components = { /** @description The name of the property */ readonly property_name: string; /** - * Format: uri * @description The URL that can be used to fetch, update, or delete info about this property via the API. + * @format uri */ readonly url?: string; /** @@ -24994,16 +25496,24 @@ export type components = { readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ readonly required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ readonly default_value?: (string | readonly string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ readonly description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ readonly allowed_values?: readonly string[] | null; /** + * @nullable * @description Who can edit the values of the property * @example org_actors * @enum {string|null} @@ -25023,11 +25533,18 @@ export type components = { readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ readonly required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ readonly default_value?: (string | readonly string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ readonly description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ @@ -25040,7 +25557,10 @@ export type components = { readonly "custom-property-value": { /** @description The name of the property */ readonly property_name: string; - /** @description The value assigned to the property */ + /** + * @nullable + * @description The value assigned to the property + */ readonly value: (string | readonly string[]) | null; }; /** @@ -25059,13 +25579,14 @@ export type components = { }; /** * Repository + * @nullable * @description A repository on GitHub. */ readonly "nullable-repository": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25093,16 +25614,19 @@ export type components = { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25124,28 +25648,28 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25167,13 +25691,13 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25187,30 +25711,30 @@ export type components = { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25218,25 +25742,28 @@ export type components = { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -25308,18 +25835,21 @@ export type components = { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -25420,8 +25950,8 @@ export type components = { */ readonly "code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ readonly url: string; /** @example citizen_code_of_conduct */ @@ -25429,8 +25959,9 @@ export type components = { /** @example Citizen Code of Conduct */ readonly name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ readonly html_url: string | null; }; @@ -25440,8 +25971,8 @@ export type components = { */ readonly "full-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25453,16 +25984,19 @@ export type components = { readonly owner: components["schemas"]["simple-user"]; readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25484,28 +26018,28 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25527,13 +26061,13 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25547,30 +26081,30 @@ export type components = { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25578,25 +26112,28 @@ export type components = { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -25644,18 +26181,18 @@ export type components = { */ readonly visibility?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string; readonly permissions?: { @@ -25668,6 +26205,7 @@ export type components = { /** @example true */ readonly allow_rebase_merge?: boolean; readonly template_repository?: components["schemas"]["nullable-repository"]; + /** @nullable */ readonly temp_clone_token?: string | null; /** @example true */ readonly allow_squash_merge?: boolean; @@ -25757,7 +26295,10 @@ 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. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** + * @nullable + * @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + */ readonly actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -26238,16 +26779,18 @@ export type components = { /** @description The URL of the ruleset */ readonly href?: string; }; + /** @nullable */ readonly html?: { /** @description The html URL of the ruleset */ readonly href?: string; } | null; }; + /** @nullable */ readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; readonly rules?: readonly components["schemas"]["repository-rule"][]; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; }; /** @@ -26272,8 +26815,8 @@ export type components = { /** @description The name of the repository without the `.git` extension. */ readonly repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at?: string; /** @@ -26294,9 +26837,15 @@ export type components = { readonly "rule-suite": { /** @description The unique identifier of the rule insight. */ readonly id?: number; - /** @description The number that identifies the user. */ + /** + * @nullable + * @description The number that identifies the user. + */ readonly actor_id?: number | null; - /** @description The handle for the GitHub user account. */ + /** + * @nullable + * @description The handle for the GitHub user account. + */ readonly actor_name?: string | null; /** @description The first commit sha before the push evaluation. */ readonly before_sha?: string; @@ -26309,8 +26858,8 @@ export type components = { /** @description The name of the repository without the `.git` extension. */ readonly repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at?: string; /** @@ -26319,6 +26868,7 @@ export type components = { */ readonly result?: "pass" | "fail" | "bypass"; /** + * @nullable * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. * @enum {string|null} */ @@ -26328,9 +26878,15 @@ export type components = { readonly rule_source?: { /** @description The type of rule source. */ readonly type?: string; - /** @description The ID of the rule source. */ + /** + * @nullable + * @description The ID of the rule source. + */ readonly id?: number | null; - /** @description The name of the rule source. */ + /** + * @nullable + * @description The name of the rule source. + */ readonly name?: string | null; }; /** @@ -26345,23 +26901,41 @@ export type components = { readonly result?: "pass" | "fail"; /** @description The type of rule. */ readonly rule_type?: string; - /** @description The detailed failure message for the rule. Null if the rule passed. */ + /** + * @nullable + * @description The detailed failure message for the rule. Null if the rule passed. + */ readonly details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ readonly "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ readonly patched_versions: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ readonly vulnerable_functions: readonly string[] | null; }; /** @description A credit given to a user for a repository security advisory. */ @@ -26378,30 +26952,43 @@ export type components = { readonly "repository-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id: string | null; /** - * Format: uri * @description The API URL for the advisory. + * @format uri */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** @description A short summary of the advisory. */ readonly summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ readonly description: string | null; /** + * @nullable * @description The severity of the advisory. * @enum {string|null} */ readonly severity: "critical" | "high" | "medium" | "low" | null; - /** @description The author of the advisory. */ + /** + * @nullable + * @description The author of the advisory. + */ readonly author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ + /** + * @nullable + * @description The publisher of the advisory. + */ readonly publisher: components["schemas"]["simple-user"] | null; readonly identifiers: readonly { /** @@ -26418,61 +27005,90 @@ export type components = { */ readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was created, in ISO 8601 format. + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was closed, in ISO 8601 format. + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; + /** @nullable */ readonly submission: { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; + /** @nullable */ readonly vulnerabilities: readonly components["schemas"]["repository-advisory-vulnerability"][] | null; + /** @nullable */ readonly cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ readonly vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; readonly cvss_severities?: components["schemas"]["cvss-severities"]; + /** @nullable */ readonly cwes: readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ readonly cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description A list of only the CWE IDs. */ + /** + * @nullable + * @description A list of only the CWE IDs. + */ readonly cwe_ids: readonly string[] | null; + /** @nullable */ readonly credits: readonly { /** @description The username of the user credited. */ readonly login?: string; readonly type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; + /** @nullable */ readonly credits_detailed: readonly components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ + /** + * @nullable + * @description A list of users that collaborate on the advisory. + */ readonly collaborating_users: readonly components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ + /** + * @nullable + * @description A list of teams that collaborate on the advisory. + */ readonly collaborating_teams: readonly components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + /** + * @nullable + * @description A temporary private fork of the advisory's repository for collaborating on a fix. + */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; readonly "actions-billing-usage": { @@ -26557,9 +27173,10 @@ export type components = { */ readonly network_settings_ids?: readonly string[]; /** - * Format: date-time + * @nullable * @description The time at which the network configuration was created, in ISO 8601 format. * @example 2024-04-26T11:31:07Z + * @format date-time */ readonly created_on: string | null; }; @@ -26606,18 +27223,18 @@ export type components = { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -26630,25 +27247,31 @@ export type components = { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; /** @example github */ readonly name?: string; /** @example GitHub */ readonly company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ readonly blog?: string; /** @example San Francisco */ readonly location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ readonly email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ readonly twitter_username?: string | null; /** @example true */ readonly is_verified?: boolean; @@ -26665,13 +27288,13 @@ export type components = { /** @example 0 */ readonly following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ readonly created_at: string; /** @example Organization */ @@ -26680,15 +27303,25 @@ export type components = { readonly total_private_repos?: number; /** @example 100 */ readonly owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ readonly private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ readonly disk_usage?: number | null; - /** @example 8 */ + /** + * @nullable + * @example 8 + */ readonly collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ readonly billing_email?: string | null; readonly plan?: { @@ -26698,10 +27331,17 @@ export type components = { readonly filled_seats?: number; readonly seats?: number; }; + /** @nullable */ readonly default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly two_factor_requirement_enabled?: boolean | null; /** @example all */ readonly members_allowed_repository_creation_type?: string; @@ -26717,13 +27357,19 @@ export type components = { readonly members_can_create_public_pages?: boolean; /** @example true */ readonly members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ readonly members_can_fork_private_repositories?: boolean | null; /** @example false */ readonly web_commit_signoff_required?: boolean; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly archived_at: string | null; }; /** @@ -26739,14 +27385,14 @@ export type components = { /** @example MDQ6VGVhbTE= */ readonly node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; /** @@ -26756,7 +27402,10 @@ export type components = { readonly name: string; /** @example justice-league */ readonly slug: string; - /** @example A great team. */ + /** + * @nullable + * @example A great team. + */ readonly description: string | null; /** * @description The level of privacy this team should have @@ -26778,8 +27427,8 @@ export type components = { /** @example https://api.github.com/organizations/1/team/1/members{/member} */ readonly members_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ readonly repositories_url: string; readonly parent?: components["schemas"]["nullable-team-simple"]; @@ -26788,13 +27437,13 @@ export type components = { /** @example 10 */ readonly repos_count: number; /** - * Format: date-time * @example 2017-07-14T16:53:42Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2017-08-17T12:37:15Z + * @format date-time */ readonly updated_at: string; readonly organization: components["schemas"]["team-organization"]; @@ -26825,20 +27474,23 @@ export type components = { /** @example 0 */ readonly comments_count: number; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments + * @format uri */ readonly comments_url: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly last_edited_at: string | null; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 + * @format uri */ readonly html_url: string; /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ @@ -26859,8 +27511,8 @@ export type components = { */ readonly private: boolean; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027 + * @format uri */ readonly team_url: string; /** @@ -26869,13 +27521,13 @@ export type components = { */ readonly title: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 + * @format uri */ readonly url: string; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -26899,20 +27551,23 @@ export type components = { */ readonly body_version: string; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly last_edited_at: string | null; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @format uri */ readonly discussion_url: string; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @format uri */ readonly html_url: string; /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ @@ -26923,13 +27578,13 @@ export type components = { */ readonly number: number; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + * @format uri */ readonly url: string; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -26951,8 +27606,8 @@ export type components = { */ readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** - * Format: date-time * @example 2016-05-20T20:09:31Z + * @format date-time */ readonly created_at: string; }; @@ -26961,7 +27616,7 @@ export type components = { * @description Team Membership */ readonly "team-membership": { - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description The role of the user in the team. @@ -26988,6 +27643,7 @@ export type components = { readonly id: number; readonly node_id: string; readonly name: string; + /** @nullable */ readonly body: string | null; readonly number: number; readonly state: string; @@ -27041,16 +27697,19 @@ export type components = { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -27072,28 +27731,28 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -27115,13 +27774,13 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -27135,30 +27794,30 @@ export type components = { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -27166,25 +27825,28 @@ export type components = { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -27246,18 +27908,21 @@ export type components = { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -27315,29 +27980,32 @@ export type components = { */ readonly "project-card": { /** - * Format: uri * @example https://api.github.com/projects/columns/cards/1478 + * @format uri */ readonly url: string; /** - * Format: int64 * @description The project card's ID * @example 42 + * @format int64 */ readonly id: number; /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ readonly node_id: string; - /** @example Add payload for delete Project column */ + /** + * @nullable + * @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 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2016-09-05T14:20:22Z + * @format date-time */ readonly updated_at: string; /** @@ -27348,18 +28016,18 @@ export type components = { readonly column_name?: string; readonly project_id?: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ readonly column_url: string; /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 + * @format uri */ readonly content_url?: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ readonly project_url: string; }; @@ -27369,18 +28037,18 @@ export type components = { */ readonly "project-column": { /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ readonly project_url: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367/cards + * @format uri */ readonly cards_url: string; /** @@ -27396,13 +28064,13 @@ export type components = { */ readonly name: string; /** - * Format: date-time * @example 2016-09-05T14:18:44Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2016-09-05T14:22:28Z + * @format date-time */ readonly updated_at: string; }; @@ -27466,12 +28134,22 @@ export type components = { readonly archive_download_url: string; /** @description Whether or not the artifact has expired. */ readonly expired: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly expires_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; + /** @nullable */ readonly workflow_run?: { /** @example 10 */ readonly id?: number; @@ -27506,13 +28184,13 @@ export type components = { /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ readonly version?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly last_accessed_at?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly created_at?: string; /** @example 1024 */ @@ -27550,7 +28228,10 @@ export type components = { readonly head_sha: string; /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ readonly url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ readonly html_url: string | null; /** * @description The phase of the lifecycle that the job is currently in. @@ -27559,27 +28240,29 @@ export type components = { */ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @description The outcome of the job. * @example success * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time * @description The time that the job created, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly started_at: string; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly completed_at: string | null; /** @@ -27596,6 +28279,7 @@ export type components = { */ readonly status: "queued" | "in_progress" | "completed"; /** + * @nullable * @description The outcome of the job. * @example success */ @@ -27608,15 +28292,17 @@ export type components = { /** @example 1 */ readonly number: number; /** - * Format: date-time + * @nullable * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly started_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly completed_at?: string | null; }[]; @@ -27632,31 +28318,37 @@ export type components = { */ readonly labels: readonly string[]; /** + * @nullable * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ readonly runner_id: number | null; /** + * @nullable * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ readonly runner_name: string | null; /** + * @nullable * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ readonly runner_group_id: number | null; /** + * @nullable * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ readonly runner_group_name: string | null; /** + * @nullable * @description The name of the workflow. * @example Build */ readonly workflow_name: string | null; /** + * @nullable * @description The name of the current branch. * @example main */ @@ -27682,9 +28374,9 @@ export type components = { * @example SECRET_TOKEN */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** Actions Variable */ @@ -27700,15 +28392,15 @@ export type components = { */ readonly value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly updated_at: string; }; @@ -27740,7 +28432,7 @@ export type components = { }; /** Pull Request Minimal */ readonly "pull-request-minimal": { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly number: number; readonly url: string; @@ -27748,7 +28440,7 @@ export type components = { readonly ref: string; readonly sha: string; readonly repo: { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly url: string; readonly name: string; @@ -27758,7 +28450,7 @@ export type components = { readonly ref: string; readonly sha: string; readonly repo: { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly url: string; readonly name: string; @@ -27767,6 +28459,7 @@ export type components = { }; /** * Simple Commit + * @nullable * @description A commit. */ readonly "nullable-simple-commit": { @@ -27783,12 +28476,15 @@ export type components = { */ readonly message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ readonly author: { /** * @description Name of the commit's author @@ -27796,13 +28492,16 @@ export type components = { */ readonly name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ readonly email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ readonly committer: { /** * @description Name of the commit's committer @@ -27810,9 +28509,9 @@ export type components = { */ readonly name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ readonly email: string; } | null; @@ -27828,6 +28527,7 @@ export type components = { */ readonly id: number; /** + * @nullable * @description The name of the workflow run. * @example Build */ @@ -27844,7 +28544,10 @@ export type components = { * @example MDEwOkNoZWNrU3VpdGU0Mg== */ readonly check_suite_node_id?: string; - /** @example master */ + /** + * @nullable + * @example master + */ readonly head_branch: string | null; /** * @description The SHA of the head commit that points to the version of the workflow being run. @@ -27866,12 +28569,19 @@ export type components = { * @example 1 */ readonly run_attempt?: number; + /** @nullable */ readonly referenced_workflows?: readonly components["schemas"]["referenced-workflow"][] | null; /** @example push */ readonly event: string; - /** @example completed */ + /** + * @nullable + * @example completed + */ readonly status: string | null; - /** @example neutral */ + /** + * @nullable + * @example neutral + */ readonly conclusion: string | null; /** * @description The ID of the parent workflow. @@ -27885,17 +28595,20 @@ export type components = { readonly url: string; /** @example https://github.com/github/hello-world/suites/4 */ readonly html_url: string; - /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */ + /** + * @nullable + * @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. + */ readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly actor?: components["schemas"]["simple-user"]; readonly triggering_actor?: components["schemas"]["simple-user"]; /** - * Format: date-time * @description The start time of the latest run. Resets on re-run. + * @format date-time */ readonly run_started_at?: string; /** @@ -27929,6 +28642,7 @@ export type components = { */ readonly rerun_url: string; /** + * @nullable * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ @@ -27973,15 +28687,15 @@ export type components = { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ readonly html_url?: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly created_at?: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly updated_at?: string; }[]; @@ -28028,9 +28742,9 @@ export type components = { readonly "pending-deployment": { readonly environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ readonly id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -28051,9 +28765,10 @@ export type components = { */ readonly wait_timer: number; /** - * Format: date-time + * @nullable * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly wait_timer_started_at: string | null; /** @@ -28073,14 +28788,14 @@ export type components = { */ readonly deployment: { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ readonly url: string; /** - * Format: int64 * @description Unique identifier of the deployment * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOkRlcGxveW1lbnQx */ @@ -28107,27 +28822,30 @@ export type components = { * @example production */ readonly environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ readonly description: string | null; readonly creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ readonly statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ readonly repository_url: string; /** @@ -28194,13 +28912,13 @@ export type components = { */ readonly state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ readonly updated_at: string; /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ @@ -28210,8 +28928,8 @@ export type components = { /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ readonly badge_url: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ readonly deleted_at?: string; }; @@ -28257,9 +28975,9 @@ export type components = { */ readonly ref: string; /** - * Format: date-time * @description The time when the activity occurred. * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly timestamp: string; /** @@ -28319,6 +29037,7 @@ export type components = { readonly contexts: readonly string[]; readonly checks: readonly { readonly context: string; + /** @nullable */ readonly app_id: number | null; }[]; readonly contexts_url?: string; @@ -28330,8 +29049,8 @@ export type components = { */ readonly "protected-branch-admin-enforced": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + * @format uri */ readonly url: string; /** @example true */ @@ -28343,8 +29062,8 @@ export type components = { */ readonly "protected-branch-pull-request-review": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + * @format uri */ readonly url?: string; readonly dismissal_restrictions?: { @@ -28388,17 +29107,17 @@ export type components = { * @description Branch Restriction Policy */ readonly "branch-restriction-policy": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly users_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri */ + /** @format uri */ readonly apps_url: string; readonly users: readonly { readonly login?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly node_id?: string; readonly avatar_url?: string; @@ -28425,12 +29144,14 @@ export type components = { readonly html_url?: string; readonly name?: string; readonly slug?: string; + /** @nullable */ readonly description?: string | null; readonly privacy?: string; readonly notification_setting?: string; readonly permission?: string; readonly members_url?: string; readonly repositories_url?: string; + /** @nullable */ readonly parent?: string | null; }[]; readonly apps: readonly { @@ -28523,8 +29244,8 @@ export type components = { readonly protection_url?: string; readonly required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ readonly url: string; /** @example true */ @@ -28549,16 +29270,17 @@ export type components = { readonly name: string; readonly commit: { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly protected: boolean; readonly protection?: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ readonly protection_url?: string; }; /** * Git User + * @nullable * @description Metaproperties for Git author/committer information. */ readonly "nullable-git-user": { @@ -28573,8 +29295,11 @@ export type components = { readonly verification: { readonly verified: boolean; readonly reason: string; + /** @nullable */ readonly payload: string | null; + /** @nullable */ readonly signature: string | null; + /** @nullable */ readonly verified_at?: string | null; }; /** @@ -28598,18 +29323,18 @@ export type components = { /** @example 124 */ readonly changes: number; /** - * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ readonly blob_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ readonly raw_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly contents_url: string; /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ @@ -28623,8 +29348,8 @@ export type components = { */ readonly commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly url: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ @@ -28632,19 +29357,19 @@ export type components = { /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ readonly node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + * @format uri */ readonly comments_url: string; readonly commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly url: string; readonly author: components["schemas"]["nullable-git-user"]; @@ -28657,26 +29382,28 @@ export type components = { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ readonly sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + * @format uri */ readonly url: string; }; readonly verification?: components["schemas"]["verification"]; }; + /** @nullable */ readonly author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + /** @nullable */ readonly committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; readonly parents: readonly { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ readonly html_url?: string; }[]; @@ -28696,12 +29423,12 @@ export type components = { readonly commit: components["schemas"]["commit"]; readonly _links: { readonly html: string; - /** Format: uri */ + /** @format uri */ readonly self: string; }; readonly protected: boolean; readonly protection: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ readonly protection_url: string; /** @example "mas*" */ readonly pattern?: string; @@ -28714,8 +29441,8 @@ export type components = { */ readonly "status-check-policy": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + * @format uri */ readonly url: string; /** @example true */ @@ -28729,11 +29456,12 @@ export type components = { readonly checks: readonly { /** @example continuous-integration/travis-ci */ readonly context: string; + /** @nullable */ readonly app_id: number | null; }[]; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + * @format uri */ readonly contexts_url: string; }; @@ -28742,11 +29470,11 @@ export type components = { * @description Branch protections protect branches */ readonly "protected-branch": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly required_status_checks?: components["schemas"]["status-check-policy"]; readonly required_pull_request_reviews?: { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly dismiss_stale_reviews?: boolean; readonly require_code_owner_reviews?: boolean; @@ -28757,11 +29485,11 @@ export type components = { */ readonly require_last_push_approval: boolean; readonly dismissal_restrictions?: { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly users_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly users: readonly components["schemas"]["simple-user"][]; readonly teams: readonly components["schemas"]["team"][]; @@ -28775,15 +29503,15 @@ export type components = { }; readonly required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ readonly url: string; /** @example true */ readonly enabled: boolean; }; readonly enforce_admins?: { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly enabled: boolean; }; @@ -28820,8 +29548,8 @@ export type components = { */ readonly "deployment-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ readonly url: string; /** @@ -28843,26 +29571,29 @@ export type components = { * @example production */ readonly environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ readonly description: string | null; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ readonly statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ readonly repository_url: string; /** @@ -28883,9 +29614,9 @@ export type components = { */ readonly "check-run": { /** - * Format: int64 * @description The id of the check. * @example 21 + * @format int64 */ readonly id: number; /** @@ -28895,13 +29626,22 @@ export type components = { readonly head_sha: string; /** @example MDg6Q2hlY2tSdW40 */ readonly node_id: string; - /** @example 42 */ + /** + * @nullable + * @example 42 + */ readonly external_id: string | null; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ readonly url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ readonly html_url: string | null; - /** @example https://example.com */ + /** + * @nullable + * @example https://example.com + */ readonly details_url: string | null; /** * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. @@ -28910,26 +29650,32 @@ export type components = { */ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @example neutral * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ readonly started_at: string | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ readonly completed_at: string | null; readonly output: { + /** @nullable */ readonly title: string | null; + /** @nullable */ readonly summary: string | null; + /** @nullable */ readonly text: string | null; readonly annotations_count: number; - /** Format: uri */ + /** @format uri */ readonly annotations_url: string; }; /** @@ -28937,6 +29683,7 @@ export type components = { * @example test-coverage */ readonly name: string; + /** @nullable */ readonly check_suite: { readonly id: number; } | null; @@ -28956,17 +29703,35 @@ export type components = { readonly start_line: number; /** @example 2 */ readonly end_line: number; - /** @example 5 */ + /** + * @nullable + * @example 5 + */ readonly start_column: number | null; - /** @example 10 */ + /** + * @nullable + * @example 10 + */ readonly end_column: number | null; - /** @example warning */ + /** + * @nullable + * @example warning + */ readonly annotation_level: string | null; - /** @example Spell Checker */ + /** + * @nullable + * @example Spell Checker + */ readonly title: string | null; - /** @example Check your spelling for 'banaas'. */ + /** + * @nullable + * @example Check your spelling for 'banaas'. + */ readonly message: string | null; - /** @example Do you mean 'bananas' or 'banana'? */ + /** + * @nullable + * @example Do you mean 'bananas' or 'banana'? + */ readonly raw_details: string | null; readonly blob_href: string; }; @@ -28988,12 +29753,15 @@ export type components = { */ readonly message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ readonly author: { /** * @description Name of the commit's author @@ -29001,13 +29769,16 @@ export type components = { */ readonly name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ readonly email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ readonly committer: { /** * @description Name of the commit's committer @@ -29015,9 +29786,9 @@ export type components = { */ readonly name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ readonly email: string; } | null; @@ -29028,13 +29799,16 @@ export type components = { */ readonly "check-suite": { /** - * Format: int64 * @example 5 + * @format int64 */ readonly id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ readonly node_id: string; - /** @example master */ + /** + * @nullable + * @example master + */ readonly head_branch: string | null; /** * @description The SHA of the head commit that is being checked. @@ -29042,28 +29816,46 @@ export type components = { */ readonly head_sha: string; /** + * @nullable * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; /** + * @nullable * @example neutral * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; - /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ + /** + * @nullable + * @example https://api.github.com/repos/github/hello-world/check-suites/5 + */ readonly url: string | null; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ readonly before: string | null; - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ readonly after: string | null; + /** @nullable */ readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; readonly app: components["schemas"]["nullable-integration"]; readonly repository: components["schemas"]["minimal-repository"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; readonly head_commit: components["schemas"]["simple-commit"]; readonly latest_check_runs_count: number; @@ -29102,16 +29894,21 @@ export type components = { readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; readonly "code-scanning-alert-rule": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ readonly id?: string | null; /** @description The name of the rule used to detect the alert. */ readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -29120,11 +29917,20 @@ export type components = { readonly description?: string; /** @description A description of the rule used to detect the alert. */ readonly full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ readonly tags?: readonly string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; }; readonly "code-scanning-alert": { @@ -29154,11 +29960,14 @@ export type components = { * @enum {string} */ readonly "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; - /** @description The description of an autofix. */ + /** + * @nullable + * @description The description of an autofix. + */ readonly "code-scanning-autofix-description": string | null; /** - * Format: date-time * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "code-scanning-autofix-started-at": string; readonly "code-scanning-autofix": { @@ -29166,7 +29975,10 @@ export type components = { readonly description: components["schemas"]["code-scanning-autofix-description"]; readonly started_at: components["schemas"]["code-scanning-autofix-started-at"]; }; - /** @description Commit an autofix for a code scanning alert */ + /** + * @nullable + * @description Commit an autofix for a code scanning alert + */ readonly "code-scanning-autofix-commits": { /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ readonly target_ref?: string; @@ -29184,18 +29996,21 @@ export type components = { * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ readonly "code-scanning-analysis-sarif-id": string; - /** @description The SHA of the commit to which the analysis you are uploading relates. */ + /** + * @description The SHA of the commit to which the analysis you are uploading relates. + * @pattern ^[0-9a-fA-F]+$ + */ readonly "code-scanning-analysis-commit-sha": string; /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ readonly "code-scanning-analysis-environment": string; /** - * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "code-scanning-analysis-created-at": string; /** - * Format: uri * @description The REST API URL of the analysis resource. + * @format uri */ readonly "code-scanning-analysis-url": string; readonly "code-scanning-analysis": { @@ -29229,13 +30044,15 @@ export type components = { */ readonly "code-scanning-analysis-deletion": { /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, without last analysis deletion confirmation + * @format uri */ readonly next_analysis_url: string | null; /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, with last analysis deletion confirmation + * @format uri */ readonly confirm_delete_url: string | null; }; @@ -29256,21 +30073,24 @@ export type components = { /** @description The size of the CodeQL database file in bytes. */ readonly size: number; /** - * Format: date-time * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. + * @format uri */ readonly url: string; - /** @description The commit SHA of the repository at the time the CodeQL database was created. */ + /** + * @nullable + * @description The commit SHA of the repository at the time the CodeQL database was created. + */ readonly commit_oid?: string | null; }; /** @@ -29303,8 +30123,9 @@ export type components = { /** @example 80 */ readonly stargazers_count: number; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; }; @@ -29335,18 +30156,19 @@ export type components = { /** @description The download url for the query pack. */ readonly query_pack_url: string; /** - * Format: date-time * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly created_at?: string; /** - * Format: date-time * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly updated_at?: string; /** - * Format: date-time + * @nullable * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + * @format date-time */ readonly completed_at?: string | null; /** @enum {string} */ @@ -29410,11 +30232,13 @@ export type components = { /** @description Languages to be analyzed. */ readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** + * @nullable * @description Runner type to be used. * @enum {string|null} */ readonly runner_type?: "standard" | "labeled" | null; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29425,12 +30249,14 @@ export type components = { */ readonly query_suite?: "default" | "extended"; /** - * Format: date-time + * @nullable * @description Timestamp of latest configuration update. * @example 2023-12-06T14:20:20.000Z + * @format date-time */ readonly updated_at?: string | null; /** + * @nullable * @description The frequency of the periodic analysis. * @enum {string|null} */ @@ -29449,6 +30275,7 @@ export type components = { */ readonly runner_type?: "standard" | "labeled"; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29475,6 +30302,7 @@ export type components = { * @description The full Git reference, formatted as `refs/heads/`, * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main + * @pattern ^refs/(heads|tags|pull)/.*$ */ 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)." */ @@ -29482,8 +30310,8 @@ export type components = { readonly "code-scanning-sarifs-receipt": { readonly id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** - * Format: uri * @description The REST API URL for checking the status of the upload. + * @format uri */ readonly url?: string; }; @@ -29494,11 +30322,15 @@ export type components = { */ readonly processing_status?: "pending" | "complete" | "failed"; /** - * Format: uri + * @nullable * @description The REST API URL for getting the analyses associated with the upload. + * @format uri */ readonly analyses_url?: string | null; - /** @description Any errors that ocurred during processing of the delivery. */ + /** + * @nullable + * @description Any errors that ocurred during processing of the delivery. + */ readonly errors?: readonly string[] | null; }; /** @description Code security configuration associated with a repository and attachment status */ @@ -29537,6 +30369,7 @@ export type components = { */ readonly kind: string; /** + * @nullable * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. * @example The pattern `/` will never match anything, did you mean `*` instead? */ @@ -29592,6 +30425,7 @@ export type components = { */ readonly cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -29619,9 +30453,9 @@ export type components = { * @example SECRET_TOKEN */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -29632,34 +30466,39 @@ export type components = { /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; + /** @nullable */ readonly email?: string | null; + /** @nullable */ readonly name?: string | null; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29669,25 +30508,25 @@ export type components = { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -29711,9 +30550,9 @@ export type components = { */ readonly "repository-invitation": { /** - * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 + * @format int64 */ readonly id: number; readonly repository: components["schemas"]["minimal-repository"]; @@ -29726,8 +30565,8 @@ export type components = { */ readonly permissions: "read" | "write" | "admin" | "triage" | "maintain"; /** - * Format: date-time * @example 2016-06-13T14:52:50-05:00 + * @format date-time */ readonly created_at: string; /** @description Whether or not the invitation has expired */ @@ -29743,40 +30582,46 @@ export type components = { }; /** * Collaborator + * @nullable * @description Collaborator */ readonly "nullable-collaborator": { /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; + /** @nullable */ readonly email?: string | null; + /** @nullable */ readonly name?: string | null; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29786,25 +30631,25 @@ export type components = { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -29837,21 +30682,24 @@ export type components = { * @description Commit Comment */ readonly "commit-comment": { - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly id: number; readonly node_id: string; readonly body: string; + /** @nullable */ readonly path: string | null; + /** @nullable */ readonly position: number | null; + /** @nullable */ readonly line: number | null; readonly commit_id: string; readonly user: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly author_association: components["schemas"]["author-association"]; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -29877,6 +30725,7 @@ export type components = { }; /** * Auto merge + * @nullable * @description The status of auto merging a pull request. */ readonly "auto-merge": { @@ -29897,57 +30746,57 @@ export type components = { */ readonly "pull-request-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ readonly url: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ readonly node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ readonly diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ readonly patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ readonly issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ readonly commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ readonly review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ readonly review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ readonly comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly statuses_url: string; /** @example 1347 */ @@ -29959,10 +30808,13 @@ export type components = { /** @example new-feature */ readonly title: string; readonly user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ readonly body: string | null; readonly labels: readonly { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; readonly url: string; @@ -29972,33 +30824,44 @@ export type components = { readonly default: boolean; }[]; readonly milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ readonly active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ readonly merge_commit_sha: string | null; readonly assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; + /** @nullable */ readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; + /** @nullable */ readonly requested_teams?: readonly components["schemas"]["team"][] | null; readonly head: { readonly label: string; @@ -30034,21 +30897,29 @@ export type components = { }; /** Simple Commit Status */ readonly "simple-commit-status": { + /** @nullable */ readonly description: string | null; readonly id: number; readonly node_id: string; readonly state: string; readonly context: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly target_url: string | null; + /** @nullable */ readonly required?: boolean | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly avatar_url: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -30061,9 +30932,9 @@ export type components = { readonly sha: string; readonly total_count: number; readonly repository: components["schemas"]["minimal-repository"]; - /** Format: uri */ + /** @format uri */ readonly commit_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -30072,11 +30943,14 @@ export type components = { */ readonly status: { readonly url: string; + /** @nullable */ readonly avatar_url: string | null; readonly id: number; readonly node_id: string; readonly state: string; + /** @nullable */ readonly description: string | null; + /** @nullable */ readonly target_url: string | null; readonly context: string; readonly created_at: string; @@ -30085,12 +30959,13 @@ export type components = { }; /** * Code Of Conduct Simple + * @nullable * @description Code of Conduct Simple */ readonly "nullable-code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ readonly url: string; /** @example citizen_code_of_conduct */ @@ -30098,16 +30973,20 @@ export type components = { /** @example Citizen Code of Conduct */ readonly name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ readonly html_url: string | null; } | null; - /** Community Health File */ + /** + * Community Health File + * @nullable + */ readonly "nullable-community-health-file": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; } | null; /** @@ -30117,9 +30996,15 @@ export type components = { readonly "community-profile": { /** @example 100 */ readonly health_percentage: number; - /** @example My first repository on GitHub! */ + /** + * @nullable + * @example My first repository on GitHub! + */ readonly description: string | null; - /** @example example.com */ + /** + * @nullable + * @example example.com + */ readonly documentation: string | null; readonly files: { readonly code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; @@ -30131,8 +31016,9 @@ export type components = { readonly pull_request_template: components["schemas"]["nullable-community-health-file"]; }; /** - * Format: date-time + * @nullable * @example 2017-02-28T19:09:29Z + * @format date-time */ readonly updated_at: string | null; /** @example true */ @@ -30144,28 +31030,28 @@ export type components = { */ readonly "commit-comparison": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + * @format uri */ readonly permalink_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff + * @format uri */ readonly diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch + * @format uri */ readonly patch_url: string; readonly base_commit: components["schemas"]["commit"]; @@ -30195,13 +31081,22 @@ export type components = { readonly path: string; readonly sha: string; readonly content?: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly entries?: readonly { readonly type: string; @@ -30209,29 +31104,50 @@ export type components = { readonly name: string; readonly path: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }[]; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }; @@ -30247,20 +31163,35 @@ export type components = { readonly path: string; readonly content?: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }[]; @@ -30280,20 +31211,35 @@ export type components = { readonly path: string; readonly content: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; /** @example "actual/actual.md" */ @@ -30316,20 +31262,35 @@ export type components = { readonly name: string; readonly path: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }; @@ -30343,26 +31304,41 @@ export type components = { * @enum {string} */ readonly type: "submodule"; - /** Format: uri */ + /** @format uri */ readonly submodule_git_url: string; readonly size: number; readonly name: string; readonly path: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }; @@ -30371,6 +31347,7 @@ export type components = { * @description File Commit */ readonly "file-commit": { + /** @nullable */ readonly content: { readonly name?: string; readonly path?: string; @@ -30415,8 +31392,11 @@ export type components = { readonly verification?: { readonly verified?: boolean; readonly reason?: string; + /** @nullable */ readonly signature?: string | null; + /** @nullable */ readonly payload?: string | null; + /** @nullable */ readonly verified_at?: string | null; }; }; @@ -30445,26 +31425,27 @@ export type components = { readonly login?: string; readonly id?: number; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; + /** @nullable */ readonly gravatar_id?: string | null; - /** Format: uri */ + /** @format uri */ readonly url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; readonly following_url?: string; readonly gists_url?: string; readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; readonly type: string; readonly site_admin?: boolean; @@ -30487,6 +31468,7 @@ export type components = { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -30501,11 +31483,15 @@ export type components = { readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; readonly dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ readonly dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ readonly dismissed_comment: string | null; readonly fixed_at: components["schemas"]["alert-fixed-at"]; readonly auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; @@ -30520,9 +31506,9 @@ export type components = { * @example MY_ARTIFACTORY_PASSWORD */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -30540,11 +31526,20 @@ export type components = { readonly name: string; /** @example 1.0.0 */ readonly version: string; - /** @example pkg:/npm/%40actions/core@1.1.0 */ + /** + * @nullable + * @example pkg:/npm/%40actions/core@1.1.0 + */ readonly package_url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ readonly license: string | null; - /** @example https://github.com/github/actions */ + /** + * @nullable + * @example https://github.com/github/actions + */ readonly source_repository_url: string | null; readonly vulnerabilities: readonly { /** @example critical */ @@ -30699,6 +31694,7 @@ export type components = { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. * @example pkg:/npm/%40actions/http-client@1.0.11 + * @pattern ^pkg */ readonly package_url?: string; readonly metadata?: components["schemas"]["metadata"]; @@ -30771,6 +31767,7 @@ export type components = { /** * @description The repository branch that triggered this snapshot. * @example refs/heads/main + * @pattern ^refs/ */ readonly ref: string; /** @description A description of the detector used. */ @@ -30797,9 +31794,9 @@ export type components = { readonly [key: string]: components["schemas"]["manifest"]; }; /** - * Format: date-time * @description The time at which the snapshot was scanned. * @example 2020-06-13T14:52:50-05:00 + * @format date-time */ readonly scanned: string; }; @@ -30809,13 +31806,13 @@ export type components = { */ readonly "deployment-status": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + * @format uri */ readonly url: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ @@ -30840,44 +31837,44 @@ export type components = { */ readonly environment: string; /** - * Format: uri * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ readonly target_url: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 + * @format uri */ readonly deployment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ readonly repository_url: string; /** - * Format: uri * @description The URL for accessing your environment. * @default * @example https://staging.example.com/ + * @format uri */ readonly environment_url: string; /** - * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ readonly log_url: string; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -30887,7 +31884,10 @@ export type components = { * @example 30 */ readonly "wait-timer": number; - /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ + /** + * @nullable + * @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. + */ readonly "deployment-branch-policy-settings": { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ readonly protected_branches: boolean; @@ -30900,9 +31900,9 @@ export type components = { */ readonly environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ readonly id: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -30917,15 +31917,15 @@ export type components = { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ readonly html_url: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly updated_at: string; /** @description Built-in deployment protection rules for the environment. */ @@ -31084,9 +32084,10 @@ export type components = { readonly blob: { readonly content: string; readonly encoding: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly sha: string; + /** @nullable */ readonly size: number | null; readonly node_id: string; readonly highlighted_content?: string; @@ -31102,14 +32103,14 @@ export type components = { */ readonly sha: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @description Identifying information for the git-user */ readonly author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly date: string; /** @@ -31126,9 +32127,9 @@ export type components = { /** @description Identifying information for the git-user */ readonly committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly date: string; /** @@ -31153,7 +32154,7 @@ export type components = { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly parents: readonly { @@ -31162,19 +32163,22 @@ export type components = { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; }[]; readonly verification: { readonly verified: boolean; readonly reason: string; + /** @nullable */ readonly signature: string | null; + /** @nullable */ readonly payload: string | null; + /** @nullable */ readonly verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; }; /** @@ -31184,7 +32188,7 @@ export type components = { readonly "git-ref": { readonly ref: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly object: { readonly type: string; @@ -31193,7 +32197,7 @@ export type components = { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; }; @@ -31212,9 +32216,9 @@ export type components = { /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ readonly sha: string; /** - * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + * @format uri */ readonly url: string; /** @@ -31230,7 +32234,7 @@ export type components = { readonly object: { readonly sha: string; readonly type: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly verification?: components["schemas"]["verification"]; @@ -31241,7 +32245,7 @@ export type components = { */ readonly "git-tree": { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly truncated: boolean; /** @@ -31302,8 +32306,11 @@ export type components = { }; /** Hook Response */ readonly "hook-response": { + /** @nullable */ readonly code: number | null; + /** @nullable */ readonly status: string | null; + /** @nullable */ readonly message: string | null; }; /** @@ -31337,33 +32344,33 @@ export type components = { readonly events: readonly string[]; readonly config: components["schemas"]["webhook-config"]; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ readonly created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test + * @format uri */ readonly test_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + * @format uri */ readonly ping_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries + * @format uri */ readonly deliveries_url?: string; readonly last_response: components["schemas"]["hook-response"]; @@ -31373,6 +32380,7 @@ export type components = { * @description A repository import from an external source. */ readonly import: { + /** @nullable */ readonly vcs: string | null; readonly use_lfs?: boolean; /** @description The URL of the originating repository. */ @@ -31381,11 +32389,17 @@ export type components = { readonly tfvc_project?: string; /** @enum {string} */ readonly status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; + /** @nullable */ readonly status_text?: string | null; + /** @nullable */ readonly failed_step?: string | null; + /** @nullable */ readonly error_message?: string | null; + /** @nullable */ readonly import_percent?: number | null; + /** @nullable */ readonly commit_count?: number | null; + /** @nullable */ readonly push_percent?: number | null; readonly has_large_files?: boolean; readonly large_files_size?: number; @@ -31396,14 +32410,15 @@ export type components = { readonly human_name?: string; }[]; readonly message?: string; + /** @nullable */ readonly authors_count?: number | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly authors_url: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly svn_root?: string; }; @@ -31417,9 +32432,9 @@ export type components = { readonly remote_name: string; readonly email: string; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly import_url: string; }; /** @@ -31434,26 +32449,27 @@ export type components = { }; /** * Issue + * @nullable * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ readonly "nullable-issue": { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -31466,6 +32482,7 @@ export type components = { */ readonly state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -31477,6 +32494,7 @@ export type components = { */ readonly title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -31490,45 +32508,67 @@ export type components = { * ] */ readonly labels: readonly (string | { - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly name?: string; + /** @nullable */ readonly description?: string | null; + /** @nullable */ readonly color?: string | null; readonly default?: boolean; })[]; readonly assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; readonly milestone: components["schemas"]["nullable-milestone"]; readonly locked: boolean; + /** @nullable */ readonly active_lock_reason?: string | null; readonly comments: number; readonly pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly draft?: boolean; readonly closed_by?: components["schemas"]["nullable-simple-user"]; readonly body_html?: string; readonly body_text?: string; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; readonly repository?: components["schemas"]["repository"]; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -31541,14 +32581,18 @@ export type components = { * @description Issue Event Label */ readonly "issue-event-label": { + /** @nullable */ readonly name: string | null; + /** @nullable */ readonly color: string | null; }; /** Issue Event Dismissed Review */ readonly "issue-event-dismissed-review": { readonly state: string; readonly review_id: number; + /** @nullable */ readonly dismissal_message: string | null; + /** @nullable */ readonly dismissal_commit_id?: string | null; }; /** @@ -31563,10 +32607,10 @@ export type components = { * @description Issue Event Project Card */ readonly "issue-event-project-card": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly project_id: number; readonly column_name: string; @@ -31586,27 +32630,33 @@ export type components = { */ readonly "issue-event": { /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDEwOklzc3VlRXZlbnQx */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 + * @format uri */ readonly url: string; readonly actor: components["schemas"]["nullable-simple-user"]; /** @example closed */ readonly event: string; - /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e + */ readonly commit_id: string | null; - /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ readonly commit_url: string | null; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; readonly issue?: components["schemas"]["nullable-issue"]; @@ -31621,6 +32671,7 @@ export type components = { readonly project_card?: components["schemas"]["issue-event-project-card"]; readonly rename?: components["schemas"]["issue-event-rename"]; readonly author_association?: components["schemas"]["author-association"]; + /** @nullable */ readonly lock_reason?: string | null; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; }; @@ -31634,7 +32685,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31653,7 +32706,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31672,7 +32727,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["integration"]; @@ -31689,7 +32746,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31706,7 +32765,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31724,7 +32785,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31742,7 +32805,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31761,7 +32826,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31779,7 +32846,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31797,13 +32866,16 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; readonly dismissed_review: { readonly state: string; readonly review_id: number; + /** @nullable */ readonly dismissal_message: string | null; readonly dismissal_commit_id?: string; }; @@ -31818,11 +32890,16 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - /** @example "off-topic" */ + /** + * @nullable + * @example "off-topic" + */ readonly lock_reason: string | null; }; /** @@ -31835,16 +32912,18 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; readonly project_card?: { readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly project_id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly column_name: string; readonly previous_column_name?: string; @@ -31860,16 +32939,18 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; readonly project_card?: { readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly project_id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly column_name: string; readonly previous_column_name?: string; @@ -31885,16 +32966,18 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; readonly project_card?: { readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly project_id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly column_name: string; readonly previous_column_name?: string; @@ -31910,16 +32993,18 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["integration"]; readonly project_card?: { readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly project_id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly column_name: string; readonly previous_column_name?: string; @@ -31936,17 +33021,17 @@ export type components = { */ readonly label: { /** - * Format: int64 * @description Unique identifier for the label. * @example 208045946 + * @format int64 */ readonly id: number; /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ readonly node_id: string; /** - * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug + * @format uri */ readonly url: string; /** @@ -31955,6 +33040,7 @@ export type components = { */ readonly name: string; /** + * @nullable * @description Optional description of the label, such as its purpose. * @example Something isn't working */ @@ -31984,9 +33070,9 @@ export type components = { readonly id: number; readonly node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ readonly url: string; /** @@ -31996,20 +33082,20 @@ export type components = { readonly body?: string; readonly body_text?: string; readonly body_html?: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly user: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly author_association: components["schemas"]["author-association"]; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -32022,9 +33108,9 @@ export type components = { readonly "timeline-cross-referenced-event": { readonly event: string; readonly actor?: components["schemas"]["simple-user"]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly source: { readonly type?: string; @@ -32043,14 +33129,14 @@ export type components = { */ readonly sha: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @description Identifying information for the git-user */ readonly author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly date: string; /** @@ -32067,9 +33153,9 @@ export type components = { /** @description Identifying information for the git-user */ readonly committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly date: string; /** @@ -32094,7 +33180,7 @@ export type components = { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly parents: readonly { @@ -32103,19 +33189,22 @@ export type components = { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; }[]; readonly verification: { readonly verified: boolean; readonly reason: string; + /** @nullable */ readonly signature: string | null; + /** @nullable */ readonly payload: string | null; + /** @nullable */ readonly verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; }; /** @@ -32133,6 +33222,7 @@ export type components = { readonly node_id: string; readonly user: components["schemas"]["simple-user"]; /** + * @nullable * @description The text of the review. * @example This looks great. */ @@ -32140,13 +33230,13 @@ export type components = { /** @example CHANGES_REQUESTED */ readonly state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ readonly pull_request_url: string; readonly _links: { @@ -32157,7 +33247,7 @@ export type components = { readonly href: string; }; }; - /** Format: date-time */ + /** @format date-time */ readonly submitted_at?: string; /** * @description A commit SHA for the review. @@ -32179,15 +33269,16 @@ export type components = { */ readonly url: string; /** - * Format: int64 + * @nullable * @description The ID of the pull request review to which the comment belongs. * @example 42 + * @format int64 */ readonly pull_request_review_id: number | null; /** - * Format: int64 * @description The ID of the pull request review comment. * @example 1 + * @format int64 */ readonly id: number; /** @@ -32237,62 +33328,65 @@ export type components = { */ readonly body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ readonly html_url: string; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ readonly pull_request_url: string; readonly author_association: components["schemas"]["author-association"]; readonly _links: { readonly self: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ readonly href: string; }; readonly html: { /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ readonly href: string; }; readonly pull_request: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ readonly href: string; }; }; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ readonly start_line?: number | null; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ readonly original_start_line?: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -32354,7 +33448,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32370,7 +33466,9 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32386,10 +33484,13 @@ export type components = { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + /** @nullable */ readonly state_reason?: string | null; }; /** @@ -32409,7 +33510,9 @@ export type components = { readonly verified: boolean; readonly created_at: string; readonly read_only: boolean; + /** @nullable */ readonly added_by?: string | null; + /** @nullable */ readonly last_used?: string | null; readonly enabled?: boolean; }; @@ -32429,23 +33532,38 @@ export type components = { readonly path: string; readonly sha: string; readonly size: number; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly type: string; readonly content: string; readonly encoding: string; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; readonly license: components["schemas"]["nullable-license-simple"]; @@ -32466,18 +33584,18 @@ export type components = { */ readonly milestone: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ readonly labels_url: string; /** @example 1002604 */ @@ -32501,7 +33619,10 @@ export type components = { * @example v1.0 */ readonly title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ readonly description: string | null; readonly creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -32509,23 +33630,25 @@ export type components = { /** @example 8 */ readonly closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ readonly due_on: string | null; }; @@ -32551,7 +33674,7 @@ export type components = { * ] */ readonly domains: readonly string[]; - /** Format: date */ + /** @format date */ readonly expires_at?: string; }; /** @@ -32560,31 +33683,35 @@ export type components = { */ readonly page: { /** - * Format: uri * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages + * @format uri */ readonly url: string; /** + * @nullable * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ readonly status: "built" | "building" | "errored" | null; /** + * @nullable * @description The Pages site's custom domain * @example example.com */ readonly cname: string | null; /** + * @nullable * @description The state if the domain is verified * @example pending * @enum {string|null} */ readonly protected_domain_state?: "pending" | "verified" | "unverified" | null; /** - * Format: date-time + * @nullable * @description The timestamp when a pending domain becomes unverified. + * @format date-time */ readonly pending_domain_unverified_at?: string | null; /** @@ -32594,12 +33721,13 @@ export type components = { */ readonly custom_404: boolean; /** - * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com + * @format uri */ readonly html_url?: string; /** + * @nullable * @description The process in which the Page will be built. * @example legacy * @enum {string|null} @@ -32623,18 +33751,19 @@ export type components = { * @description Page Build */ readonly "page-build": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly status: string; readonly error: { + /** @nullable */ readonly message: string | null; }; readonly pusher: components["schemas"]["nullable-simple-user"]; readonly commit: string; readonly duration: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -32643,8 +33772,8 @@ export type components = { */ readonly "page-build-status": { /** - * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest + * @format uri */ readonly url: string; /** @example queued */ @@ -32658,21 +33787,21 @@ export type components = { /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ readonly id: number | string; /** - * Format: uri * @description The URI to monitor GitHub Pages deployment status. * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 + * @format uri */ readonly status_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages. * @example hello-world.github.io + * @format uri */ readonly page_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages preview. * @example monalisa-1231a2312sa32-23sda74.drafts.github.io + * @format uri */ readonly preview_url?: string; }; @@ -32694,59 +33823,96 @@ export type components = { readonly uri?: string; readonly nameservers?: string; readonly dns_resolves?: boolean; + /** @nullable */ readonly is_proxied?: boolean | null; + /** @nullable */ readonly is_cloudflare_ip?: boolean | null; + /** @nullable */ readonly is_fastly_ip?: boolean | null; + /** @nullable */ readonly is_old_ip_address?: boolean | null; + /** @nullable */ readonly is_a_record?: boolean | null; + /** @nullable */ readonly has_cname_record?: boolean | null; + /** @nullable */ readonly has_mx_records_present?: boolean | null; readonly is_valid_domain?: boolean; readonly is_apex_domain?: boolean; + /** @nullable */ readonly should_be_a_record?: boolean | null; + /** @nullable */ readonly is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ readonly is_cname_to_fastly?: boolean | null; + /** @nullable */ readonly is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ readonly is_non_github_pages_ip_present?: boolean | null; readonly is_pages_domain?: boolean; + /** @nullable */ readonly is_served_by_pages?: boolean | null; readonly is_valid?: boolean; + /** @nullable */ readonly reason?: string | null; readonly responds_to_https?: boolean; readonly enforces_https?: boolean; + /** @nullable */ readonly https_error?: string | null; + /** @nullable */ readonly is_https_eligible?: boolean | null; + /** @nullable */ readonly caa_error?: string | null; }; + /** @nullable */ readonly alt_domain?: { readonly host?: string; readonly uri?: string; readonly nameservers?: string; readonly dns_resolves?: boolean; + /** @nullable */ readonly is_proxied?: boolean | null; + /** @nullable */ readonly is_cloudflare_ip?: boolean | null; + /** @nullable */ readonly is_fastly_ip?: boolean | null; + /** @nullable */ readonly is_old_ip_address?: boolean | null; + /** @nullable */ readonly is_a_record?: boolean | null; + /** @nullable */ readonly has_cname_record?: boolean | null; + /** @nullable */ readonly has_mx_records_present?: boolean | null; readonly is_valid_domain?: boolean; readonly is_apex_domain?: boolean; + /** @nullable */ readonly should_be_a_record?: boolean | null; + /** @nullable */ readonly is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ readonly is_cname_to_fastly?: boolean | null; + /** @nullable */ readonly is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ readonly is_non_github_pages_ip_present?: boolean | null; readonly is_pages_domain?: boolean; + /** @nullable */ readonly is_served_by_pages?: boolean | null; readonly is_valid?: boolean; + /** @nullable */ readonly reason?: string | null; readonly responds_to_https?: boolean; readonly enforces_https?: boolean; + /** @nullable */ readonly https_error?: string | null; + /** @nullable */ readonly is_https_eligible?: boolean | null; + /** @nullable */ readonly caa_error?: string | null; } | null; }; @@ -32756,57 +33922,57 @@ export type components = { */ readonly "pull-request": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ readonly url: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ readonly node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ readonly diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ readonly patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ readonly issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ readonly commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ readonly review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ readonly review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ readonly comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly statuses_url: string; /** @@ -32828,46 +33994,61 @@ export type components = { */ readonly title: string; readonly user: components["schemas"]["simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ readonly body: string | null; readonly labels: readonly { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; readonly url: string; readonly name: string; + /** @nullable */ readonly description: string | null; readonly color: string; readonly default: boolean; }[]; readonly milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ readonly active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ readonly merge_commit_sha: string | null; readonly assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; + /** @nullable */ readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; + /** @nullable */ readonly requested_teams?: readonly components["schemas"]["team-simple"][] | null; readonly head: { readonly label: string; @@ -32901,9 +34082,15 @@ export type components = { */ readonly draft?: boolean; readonly merged: boolean; - /** @example true */ + /** + * @nullable + * @example true + */ readonly mergeable: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly rebaseable?: boolean | null; /** @example clean */ readonly mergeable_state: string; @@ -32949,9 +34136,9 @@ export type components = { */ readonly "pull-request-review": { /** - * Format: int64 * @description Unique identifier of the review * @example 42 + * @format int64 */ readonly id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ @@ -32965,13 +34152,13 @@ export type components = { /** @example CHANGES_REQUESTED */ readonly state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ readonly pull_request_url: string; readonly _links: { @@ -32982,9 +34169,10 @@ export type components = { readonly href: string; }; }; - /** Format: date-time */ + /** @format date-time */ readonly submitted_at?: string; /** + * @nullable * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ @@ -32999,18 +34187,19 @@ export type components = { */ readonly "review-comment": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ readonly url: string; /** - * Format: int64 + * @nullable * @example 42 + * @format int64 */ readonly pull_request_review_id: number | null; /** - * Format: int64 * @example 10 + * @format int64 */ readonly id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ @@ -33019,7 +34208,10 @@ export type components = { readonly diff_hunk: string; /** @example file1.txt */ readonly path: string; - /** @example 1 */ + /** + * @nullable + * @example 1 + */ readonly position: number | null; /** @example 4 */ readonly original_position: number; @@ -33033,23 +34225,23 @@ export type components = { /** @example Great stuff */ readonly body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ readonly pull_request_url: string; readonly author_association: components["schemas"]["author-association"]; @@ -33068,6 +34260,7 @@ export type components = { */ readonly side: "LEFT" | "RIGHT"; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -33084,11 +34277,13 @@ export type components = { */ readonly original_line?: number; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ readonly start_line?: number | null; /** + * @nullable * @description The original first line of the range for a multi-line comment. * @example 2 */ @@ -33099,9 +34294,9 @@ export type components = { * @description Data related to a release. */ readonly "release-asset": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly browser_download_url: string; readonly id: number; readonly node_id: string; @@ -33110,6 +34305,7 @@ export type components = { * @example Team Environment */ readonly name: string; + /** @nullable */ readonly label: string | null; /** * @description State of the release asset. @@ -33119,9 +34315,9 @@ export type components = { readonly content_type: string; readonly size: number; readonly download_count: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly uploader: components["schemas"]["nullable-simple-user"]; }; @@ -33130,16 +34326,22 @@ export type components = { * @description A release. */ readonly release: { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly assets_url: string; readonly upload_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly tarball_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly zipball_url: string | null; readonly id: number; readonly node_id: string; @@ -33153,7 +34355,9 @@ export type components = { * @example master */ readonly target_commitish: string; + /** @nullable */ readonly name: string | null; + /** @nullable */ readonly body?: string | null; /** * @description true to create a draft (unpublished) release, false to create a published one. @@ -33165,9 +34369,12 @@ export type components = { * @example false */ readonly prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly published_at: string | null; readonly author: components["schemas"]["simple-user"]; readonly assets: readonly components["schemas"]["release-asset"][]; @@ -33175,8 +34382,8 @@ export type components = { readonly body_text?: string; readonly mentions_count?: number; /** - * Format: uri * @description The URL of the release discussion. + * @format uri */ readonly discussion_url?: string; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -33221,19 +34428,23 @@ export type components = { readonly url?: components["schemas"]["alert-url"]; readonly html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ readonly locations_url?: string; readonly state?: components["schemas"]["secret-scanning-alert-state"]; readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly resolved_at?: string | null; readonly resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ readonly resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; @@ -33244,22 +34455,33 @@ export type components = { readonly secret_type_display_name?: string; /** @description The secret that was detected. */ readonly secret?: string; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ readonly push_protection_bypassed?: boolean | null; readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly push_protection_bypassed_at?: string | null; readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ readonly push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ readonly push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ readonly push_protection_bypass_request_html_url?: string | null; /** @@ -33267,12 +34489,21 @@ export type components = { * @enum {string} */ readonly validity?: "active" | "inactive" | "unknown"; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ readonly publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. + */ readonly multi_repo?: boolean | null; }; - /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ + /** + * @nullable + * @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. + */ readonly "secret-scanning-alert-resolution-comment": string | null; /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ readonly "secret-scanning-location-commit": { @@ -33343,99 +34574,99 @@ export type components = { /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ readonly "secret-scanning-location-issue-title": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ readonly issue_title_url: string; }; /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ readonly "secret-scanning-location-issue-body": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ readonly issue_body_url: string; }; /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ readonly "secret-scanning-location-issue-comment": { /** - * Format: uri * @description The API URL to get the issue comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ readonly issue_comment_url: string; }; /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ readonly "secret-scanning-location-discussion-title": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082 + * @format uri */ readonly discussion_title_url: string; }; /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ readonly "secret-scanning-location-discussion-body": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussion-4566270 + * @format uri */ readonly discussion_body_url: string; }; /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ readonly "secret-scanning-location-discussion-comment": { /** - * Format: uri * @description The API URL to get the discussion comment where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + * @format uri */ readonly discussion_comment_url: string; }; /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ readonly "secret-scanning-location-pull-request-title": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ readonly pull_request_title_url: string; }; /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ readonly "secret-scanning-location-pull-request-body": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ readonly pull_request_body_url: string; }; /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ readonly "secret-scanning-location-pull-request-comment": { /** - * Format: uri * @description The API URL to get the pull request comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ readonly pull_request_comment_url: string; }; /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ readonly "secret-scanning-location-pull-request-review": { /** - * Format: uri * @description The API URL to get the pull request review where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + * @format uri */ readonly pull_request_review_url: string; }; /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ readonly "secret-scanning-location-pull-request-review-comment": { /** - * Format: uri * @description The API URL to get the pull request review comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + * @format uri */ readonly pull_request_review_comment_url: string; }; @@ -33456,8 +34687,9 @@ export type components = { readonly "secret-scanning-push-protection-bypass": { readonly reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** - * Format: date-time + * @nullable * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly expire_at?: string | null; /** @description The token type this bypass is for. */ @@ -33470,13 +34702,15 @@ export type components = { /** @description The state of the scan. Either "completed", "running", or "pending" */ readonly status?: string; /** - * Format: date-time + * @nullable * @description The time that the scan was completed. Empty if the scan is running + * @format date-time */ readonly completed_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the scan was started. Empty if the scan is pending + * @format date-time */ readonly started_at?: string | null; }; @@ -33496,37 +34730,62 @@ export type components = { readonly summary: string; /** @description A detailed description of what the advisory impacts. */ readonly description: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ readonly vulnerabilities: readonly { /** @description The name of the package affected by the vulnerability. */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ readonly patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ readonly vulnerable_functions?: readonly string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ readonly cwe_ids?: readonly string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ readonly credits?: readonly { /** @description The username of the user credited. */ readonly login: string; readonly type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ readonly severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ readonly cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33539,29 +34798,51 @@ export type components = { readonly summary: string; /** @description A detailed description of what the advisory impacts. */ readonly description: string; - /** @description An array of products affected by the vulnerability detailed in a repository security advisory. */ + /** + * @nullable + * @description An array of products affected by the vulnerability detailed in a repository security advisory. + */ readonly vulnerabilities?: readonly { /** @description The name of the package affected by the vulnerability. */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ readonly patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ readonly vulnerable_functions?: readonly string[] | null; }[] | null; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ readonly cwe_ids?: readonly string[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ readonly severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ readonly cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33574,46 +34855,77 @@ export type components = { readonly summary?: string; /** @description A detailed description of what the advisory impacts. */ readonly description?: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ readonly vulnerabilities?: readonly { /** @description The name of the package affected by the vulnerability. */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ readonly patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ readonly vulnerable_functions?: readonly string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ readonly cwe_ids?: readonly string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ readonly credits?: readonly { /** @description The username of the user credited. */ readonly login: string; readonly type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ readonly severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ readonly cvss_vector_string?: string | null; /** * @description The state of the advisory. * @enum {string} */ readonly state?: "published" | "closed" | "draft"; - /** @description A list of usernames who have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of usernames who have been granted write access to the advisory. + */ readonly collaborating_users?: readonly string[] | null; - /** @description A list of team slugs which have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of team slugs which have been granted write access to the advisory. + */ readonly collaborating_teams?: readonly string[] | null; }; /** @@ -33621,7 +34933,7 @@ export type components = { * @description Stargazer */ readonly stargazer: { - /** Format: date-time */ + /** @format date-time */ readonly starred_at: string; readonly user: components["schemas"]["nullable-simple-user"]; }; @@ -33694,20 +35006,21 @@ export type components = { readonly subscribed: boolean; /** @description Determines if all notifications should be blocked from this repository. */ readonly ignored: boolean; + /** @nullable */ readonly reason: string | null; /** - * Format: date-time * @example 2012-10-06T21:34:12Z + * @format date-time */ readonly created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/subscription + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ readonly repository_url: string; }; @@ -33720,17 +35033,17 @@ export type components = { readonly name: string; readonly commit: { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** - * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 + * @format uri */ readonly zipball_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 + * @format uri */ readonly tarball_url: string; readonly node_id: string; @@ -33760,7 +35073,7 @@ export type components = { }; /** Traffic */ readonly traffic: { - /** Format: date-time */ + /** @format date-time */ readonly timestamp: string; readonly uniques: number; readonly count: number; @@ -33816,6 +35129,7 @@ export type components = { /** Search Result Text Matches */ readonly "search-result-text-matches": readonly { readonly object_url?: string; + /** @nullable */ readonly object_type?: string | null; readonly property?: string; readonly fragment?: string; @@ -33832,17 +35146,18 @@ export type components = { readonly name: string; readonly path: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly repository: components["schemas"]["minimal-repository"]; readonly score: number; readonly file_size?: number; + /** @nullable */ readonly language?: string | null; - /** Format: date-time */ + /** @format date-time */ readonly last_modified_at?: string; /** * @example [ @@ -33858,18 +35173,18 @@ export type components = { * @description Commit Search Result Item */ readonly "commit-search-result-item": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commit: { readonly author: { readonly name: string; readonly email: string; - /** Format: date-time */ + /** @format date-time */ readonly date: string; }; readonly committer: components["schemas"]["nullable-git-user"]; @@ -33877,10 +35192,10 @@ export type components = { readonly message: string; readonly tree: { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly verification?: components["schemas"]["verification"]; }; @@ -33901,34 +35216,37 @@ export type components = { * @description Issue Search Result Item */ readonly "issue-search-result-item": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; readonly number: number; readonly title: string; readonly locked: boolean; + /** @nullable */ readonly active_lock_reason?: string | null; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; readonly user: components["schemas"]["nullable-simple-user"]; readonly labels: readonly { - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly node_id?: string; readonly url?: string; readonly name?: string; readonly color?: string; readonly default?: boolean; + /** @nullable */ readonly description?: string | null; }[]; /** Sub-issues Summary */ @@ -33938,27 +35256,46 @@ export type components = { readonly percent_completed: number; }; readonly state: string; + /** @nullable */ readonly state_reason?: string | null; readonly assignee: components["schemas"]["nullable-simple-user"]; readonly milestone: components["schemas"]["nullable-milestone"]; readonly comments: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly text_matches?: components["schemas"]["search-result-text-matches"]; readonly pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; }; readonly body?: string; @@ -33968,7 +35305,7 @@ export type components = { readonly repository?: components["schemas"]["repository"]; readonly body_html?: string; readonly body_text?: string; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -33980,11 +35317,12 @@ export type components = { readonly "label-search-result-item": { readonly id: number; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly name: string; readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly score: number; readonly text_matches?: components["schemas"]["search-result-text-matches"]; @@ -34000,58 +35338,63 @@ export type components = { readonly full_name: string; readonly owner: components["schemas"]["nullable-simple-user"]; readonly private: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; + /** @nullable */ readonly description: string | null; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** @format date-time */ readonly pushed_at: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly homepage: string | null; readonly size: number; readonly stargazers_count: number; readonly watchers_count: number; + /** @nullable */ readonly language: string | null; readonly forks_count: number; readonly open_issues_count: number; readonly master_branch?: string; readonly default_branch: string; readonly score: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly keys_url: string; readonly collaborators_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; readonly issue_events_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly assignees_url: string; readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; readonly blobs_url: string; readonly git_tags_url: string; readonly git_refs_url: string; readonly trees_url: string; readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; readonly commits_url: string; readonly git_commits_url: string; @@ -34059,10 +35402,10 @@ export type components = { readonly issue_comment_url: string; readonly contents_url: string; readonly compare_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; readonly archive_url: string; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; readonly issues_url: string; readonly pulls_url: string; @@ -34070,18 +35413,21 @@ export type components = { readonly notifications_url: string; readonly labels_url: string; readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; readonly git_url: string; readonly ssh_url: string; readonly clone_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; readonly forks: number; readonly open_issues: number; readonly watchers: number; readonly topics?: readonly string[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; readonly has_issues: boolean; readonly has_projects: boolean; @@ -34120,22 +35466,32 @@ export type components = { */ readonly "topic-search-result-item": { readonly name: string; + /** @nullable */ readonly display_name: string | null; + /** @nullable */ readonly short_description: string | null; + /** @nullable */ readonly description: string | null; + /** @nullable */ readonly created_by: string | null; + /** @nullable */ readonly released: string | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly featured: boolean; readonly curated: boolean; readonly score: number; + /** @nullable */ readonly repository_count?: number | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly logo_url?: string | null; readonly text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ readonly related?: readonly { readonly topic_relation?: { readonly id?: number; @@ -34144,6 +35500,7 @@ export type components = { readonly relation_type?: string; }; }[] | null; + /** @nullable */ readonly aliases?: readonly { readonly topic_relation?: { readonly id?: number; @@ -34159,25 +35516,26 @@ export type components = { */ readonly "user-search-result-item": { readonly login: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; + /** @nullable */ readonly gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly followers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url: string; - /** Format: uri */ + /** @format uri */ readonly repos_url: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url: string; readonly type: string; readonly score: number; @@ -34189,21 +35547,33 @@ export type components = { readonly public_gists?: number; readonly followers?: number; readonly following?: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; + /** @nullable */ readonly name?: string | null; + /** @nullable */ readonly bio?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email?: string | null; + /** @nullable */ readonly location?: string | null; readonly site_admin: boolean; + /** @nullable */ readonly hireable?: boolean | null; readonly text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ readonly blog?: string | null; + /** @nullable */ readonly company?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly suspended_at?: string | null; readonly user_view_type?: string; }; @@ -34215,8 +35585,8 @@ export type components = { /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @@ -34227,25 +35597,28 @@ export type components = { /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -34255,52 +35628,73 @@ export type components = { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ readonly type: string; readonly site_admin: boolean; - /** @example monalisa octocat */ + /** + * @nullable + * @example monalisa octocat + */ readonly name: string | null; - /** @example GitHub */ + /** + * @nullable + * @example GitHub + */ readonly company: string | null; - /** @example https://github.com/blog */ + /** + * @nullable + * @example https://github.com/blog + */ readonly blog: string | null; - /** @example San Francisco */ + /** + * @nullable + * @example San Francisco + */ readonly location: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ readonly email: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ readonly notification_email?: string | null; + /** @nullable */ readonly hireable: boolean | null; - /** @example There once was... */ + /** + * @nullable + * @example There once was... + */ readonly bio: string | null; - /** @example monalisa */ + /** + * @nullable + * @example monalisa + */ readonly twitter_username?: string | null; /** @example 2 */ readonly public_repos: number; @@ -34311,13 +35705,13 @@ export type components = { /** @example 0 */ readonly following: number; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ readonly updated_at: string; /** @example 81 */ @@ -34352,13 +35746,13 @@ export type components = { */ readonly name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly updated_at: string; /** @@ -34367,9 +35761,9 @@ export type components = { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/user/secrets/SECRET_NAME/repositories + * @format uri */ readonly selected_repositories_url: string; }; @@ -34395,22 +35789,26 @@ export type components = { */ readonly "codespace-export-details": { /** + * @nullable * @description State of the latest export * @example succeeded | failed | in_progress */ readonly state?: string | null; /** - * Format: date-time + * @nullable * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z + * @format date-time */ readonly completed_at?: string | null; /** + * @nullable * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ readonly branch?: string | null; /** + * @nullable * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ @@ -34426,6 +35824,7 @@ export type components = { */ readonly export_url?: string; /** + * @nullable * @description Web url for the exported branch * @example https://github.com/octocat/hello-world/tree/:branch */ @@ -34437,8 +35836,8 @@ export type components = { */ readonly "codespace-with-full-repository": { /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @@ -34447,11 +35846,13 @@ export type components = { */ readonly name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ readonly display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -34461,29 +35862,31 @@ export type components = { readonly repository: components["schemas"]["full-repository"]; readonly machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ readonly devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ readonly prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly last_used_at: string; /** @@ -34493,8 +35896,8 @@ export type components = { */ readonly state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ readonly url: string; /** @description Details about the codespace's git repository. */ @@ -34526,60 +35929,77 @@ export type components = { */ readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ readonly idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ readonly web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ readonly machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ readonly start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ readonly stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ readonly publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ readonly pulls_url: string | null; readonly recent_folders: readonly string[]; readonly runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ readonly allowed_port_privacy_settings?: readonly string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ readonly pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ readonly pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ readonly idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ readonly retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ readonly retention_expires_at?: string | null; }; @@ -34589,15 +36009,18 @@ export type components = { */ readonly email: { /** - * Format: email * @example octocat@github.com + * @format email */ readonly email: string; /** @example true */ readonly primary: boolean; /** @example true */ readonly verified: boolean; - /** @example public */ + /** + * @nullable + * @example public + */ readonly visibility: string | null; }; /** @@ -34606,12 +36029,16 @@ export type components = { */ readonly "gpg-key": { /** - * Format: int64 * @example 3 + * @format int64 */ readonly id: number; - /** @example Octocat's GPG Key */ + /** + * @nullable + * @example Octocat's GPG Key + */ readonly name?: string | null; + /** @nullable */ readonly primary_key_id: number | null; /** @example 3262EFF25BA0D270 */ readonly key_id: string; @@ -34648,7 +36075,7 @@ export type components = { * ] */ readonly subkeys: readonly { - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly primary_key_id?: number; readonly key_id?: string; @@ -34663,7 +36090,9 @@ export type components = { readonly can_encrypt_storage?: boolean; readonly can_certify?: boolean; readonly created_at?: string; + /** @nullable */ readonly expires_at?: string | null; + /** @nullable */ readonly raw_key?: string | null; readonly revoked?: boolean; }[]; @@ -34674,14 +36103,18 @@ export type components = { /** @example true */ readonly can_certify: boolean; /** - * Format: date-time * @example 2016-03-24T11:31:04-06:00 + * @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly expires_at: string | null; /** @example true */ readonly revoked: boolean; + /** @nullable */ readonly raw_key: string | null; }; /** @@ -34690,26 +36123,32 @@ export type components = { */ readonly key: { readonly key: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly url: string; readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly verified: boolean; readonly read_only: boolean; }; /** Marketplace Account */ readonly "marketplace-account": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly id: number; readonly type: string; readonly node_id?: string; readonly login: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly organization_billing_email?: string | null; }; /** @@ -34720,21 +36159,25 @@ export type components = { /** @example monthly */ readonly billing_cycle: string; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ readonly next_billing_date: string | null; + /** @nullable */ readonly unit_count: number | null; /** @example true */ readonly on_free_trial: boolean; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ readonly free_trial_ends_on: string | null; /** - * Format: date-time + * @nullable * @example 2017-11-02T01:12:12Z + * @format date-time */ readonly updated_at: string | null; readonly account: components["schemas"]["marketplace-account"]; @@ -34758,7 +36201,7 @@ export type components = { readonly key: string; readonly id: number; readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; }; /** @@ -34766,7 +36209,7 @@ export type components = { * @description Starred Repository */ readonly "starred-repository": { - /** Format: date-time */ + /** @format date-time */ readonly starred_at: string; readonly repo: components["schemas"]["repository"]; }; @@ -34795,9 +36238,11 @@ export type components = { readonly inclusionPromise?: { readonly signedEntryTimestamp?: string; }; + /** @nullable */ readonly inclusionProof?: string | null; readonly canonicalizedBody?: string; }[]; + /** @nullable */ readonly timestampVerificationData?: string | null; }; readonly dsseEnvelope?: { @@ -34834,16 +36279,20 @@ export type components = { * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." */ readonly "enterprise-webhooks": { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ readonly description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ readonly website_url?: string | null; /** @@ -34864,16 +36313,18 @@ export type components = { */ readonly slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; }; /** @@ -34907,18 +36358,18 @@ export type components = { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -34931,7 +36382,10 @@ export type components = { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; }; /** @@ -34941,9 +36395,9 @@ export type components = { */ readonly "repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -34972,16 +36426,19 @@ export type components = { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -35003,28 +36460,28 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -35046,13 +36503,13 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -35066,30 +36523,30 @@ export type components = { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -35097,25 +36554,28 @@ export type components = { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -35190,18 +36650,21 @@ export type components = { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -35210,6 +36673,7 @@ export type components = { * @example true */ readonly allow_rebase_merge: boolean; + /** @nullable */ readonly template_repository?: { readonly id?: number; readonly node_id?: string; @@ -35456,7 +36920,7 @@ export type components = { readonly authorized_actors_only: boolean; readonly authorized_dismissal_actors_only: boolean; readonly create_protected?: boolean; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly dismiss_stale_reviews_on_push: boolean; readonly id: number; @@ -35490,24 +36954,34 @@ export type components = { /** @enum {string} */ readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; readonly strict_required_status_checks_policy: boolean; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @description A suite of checks performed on the code of a given code change */ readonly "simple-check-suite": { - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ readonly after?: string | null; readonly app?: components["schemas"]["integration"]; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ readonly before?: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ readonly conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** @example master */ + /** + * @nullable + * @example master + */ readonly head_branch?: string | null; /** * @description The SHA of the head commit that is being checked. @@ -35525,7 +36999,7 @@ export type components = { * @enum {string} */ readonly status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ readonly url?: string; @@ -35538,11 +37012,13 @@ export type components = { readonly app: components["schemas"]["nullable-integration"]; readonly check_suite: components["schemas"]["simple-check-suite"]; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ readonly completed_at: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ @@ -35573,16 +37049,19 @@ export type components = { readonly node_id: string; readonly output: { readonly annotations_count: number; - /** Format: uri */ + /** @format uri */ readonly annotations_url: string; + /** @nullable */ readonly summary: string | null; + /** @nullable */ readonly text: string | null; + /** @nullable */ readonly title: string | null; }; readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][]; /** - * Format: date-time * @example 2018-05-04T01:14:52Z + * @format date-time */ readonly started_at: string; /** @@ -35604,34 +37083,39 @@ export type components = { readonly webhooks_ref_0: string; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ readonly webhooks_deploy_key: { + /** @nullable */ readonly added_by?: string | null; readonly created_at: string; readonly id: number; readonly key: string; + /** @nullable */ readonly last_used?: string | null; readonly read_only: boolean; readonly title: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly verified: boolean; readonly enabled?: boolean; }; - /** Workflow */ + /** + * Workflow + * @nullable + */ readonly webhooks_workflow: { - /** Format: uri */ + /** @format uri */ readonly badge_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly name: string; readonly node_id: string; readonly path: string; readonly state: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly webhooks_approver: { @@ -35656,92 +37140,102 @@ export type components = { readonly user_view_type?: string; }; readonly webhooks_reviewers: readonly { - /** User */ + /** + * User + * @nullable + */ readonly reviewer?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; /** @enum {string} */ readonly type?: "User"; }[]; readonly webhooks_workflow_job_run: { + /** @nullable */ readonly conclusion: unknown; readonly created_at: string; readonly environment: string; readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: unknown; readonly status: string; readonly updated_at: string; }; - /** User */ + /** + * User + * @nullable + */ readonly webhooks_user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -35754,12 +37248,13 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; readonly body: string; readonly child_comment_count: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly discussion_id: number; readonly html_url: string; readonly id: number; readonly node_id: string; + /** @nullable */ readonly parent_id: unknown; /** Reactions */ readonly reactions?: { @@ -35772,48 +37267,52 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly repository_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -35823,46 +37322,53 @@ export type components = { * @description A Discussion in a repository. */ readonly discussion: { + /** @nullable */ readonly active_lock_reason: string | null; + /** @nullable */ readonly answer_chosen_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly answer_chosen_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly answer_html_url: string | null; /** * AuthorAssociation @@ -35872,7 +37378,7 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; readonly body: string; readonly category: { - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly description: string; readonly emoji: string; @@ -35885,7 +37391,7 @@ export type components = { readonly updated_at: string; }; readonly comments: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly html_url: string; readonly id: number; @@ -35903,7 +37409,7 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly repository_url: string; @@ -35915,6 +37421,7 @@ export type components = { */ readonly state: "open" | "closed" | "locked" | "converting" | "transferring"; /** + * @nullable * @description The reason for the current state * @example resolved * @enum {string|null} @@ -35922,44 +37429,48 @@ export type components = { readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; readonly timeline_url?: string; readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -35979,6 +37490,7 @@ export type components = { readonly html_url: string; readonly id: number; readonly node_id: string; + /** @nullable */ readonly parent_id: number | null; /** Reactions */ readonly reactions: { @@ -35991,47 +37503,51 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly repository_url: string; readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36041,14 +37557,15 @@ export type components = { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }; @@ -36092,16 +37609,16 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ readonly body: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly node_id: string; readonly performed_via_github_app: components["schemas"]["integration"]; @@ -36116,52 +37633,56 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36178,80 +37699,88 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly webhooks_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -36261,95 +37790,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -36362,67 +37910,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36501,19 +38064,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -36527,10 +38096,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -36543,54 +38112,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36600,56 +38174,67 @@ export type components = { * @description A collection of related issues and pull requests. */ readonly webhooks_milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -36662,9 +38247,9 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -36672,80 +38257,88 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly webhooks_issue_2: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -36755,95 +38348,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -36856,67 +38468,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36995,19 +38622,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -37021,10 +38654,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -37037,93 +38670,102 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** User */ + /** + * User + * @nullable + */ readonly webhooks_user_mannequin: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -37133,11 +38775,14 @@ export type components = { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: string | null; + /** @nullable */ readonly next_billing_date: string | null; readonly on_free_trial: boolean; readonly plan: { @@ -37149,6 +38794,7 @@ export type components = { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -37160,11 +38806,14 @@ export type components = { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: unknown; + /** @nullable */ readonly next_billing_date?: string | null; readonly on_free_trial: boolean; readonly plan: { @@ -37176,6 +38825,7 @@ export type components = { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -37187,25 +38837,32 @@ export type components = { */ readonly webhooks_team: { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -37219,12 +38876,12 @@ export type components = { * @enum {string} */ readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -37234,12 +38891,12 @@ export type components = { readonly privacy?: "open" | "closed" | "secret"; /** @enum {string} */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }; @@ -37260,14 +38917,15 @@ export type components = { }; /** * Repository + * @nullable * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ readonly "nullable-repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -37296,16 +38954,19 @@ export type components = { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -37327,28 +38988,28 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -37370,13 +39031,13 @@ export type components = { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -37390,30 +39051,30 @@ export type components = { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -37421,25 +39082,28 @@ export type components = { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -37514,18 +39178,21 @@ export type components = { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -37534,6 +39201,7 @@ export type components = { * @example true */ readonly allow_rebase_merge: boolean; + /** @nullable */ readonly template_repository?: { readonly id?: number; readonly node_id?: string; @@ -37771,56 +39439,67 @@ export type components = { * @description A collection of related issues and pull requests. */ readonly webhooks_milestone_3: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -37833,9 +39512,9 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -37843,48 +39522,52 @@ export type components = { * @description The membership between the user and the organization. Not present when the action is `member_invited`. */ readonly webhooks_membership: { - /** Format: uri */ + /** @format uri */ readonly organization_url: string; readonly role: string; readonly state: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -37938,9 +39621,15 @@ export type components = { * @enum {string} */ readonly repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ readonly repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ readonly repositories: readonly { readonly full_name: string; /** @description Unique identifier of the repository */ @@ -37959,154 +39648,174 @@ export type components = { readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ readonly token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ readonly token_last_used_at: string | null; }; /** Project Card */ readonly webhooks_project_card: { + /** @nullable */ readonly after_id?: number | null; /** @description Whether or not the card is archived */ readonly archived: boolean; readonly column_id: number; - /** Format: uri */ + /** @format uri */ readonly column_url: string; - /** Format: uri */ + /** @format uri */ readonly content_url?: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; readonly node_id: string; + /** @nullable */ readonly note: string | null; - /** Format: uri */ + /** @format uri */ readonly project_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** Project */ readonly webhooks_project: { - /** @description Body of the project */ + /** + * @nullable + * @description Body of the project + */ readonly body: string | null; - /** Format: uri */ + /** @format uri */ readonly columns_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; /** @description Name of the project */ readonly name: string; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly owner_url: string; /** * @description State of the project; either 'open' or 'closed' * @enum {string} */ readonly state: "open" | "closed"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** Project Column */ readonly webhooks_project_column: { + /** @nullable */ readonly after_id?: number | null; - /** Format: uri */ + /** @format uri */ readonly cards_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The unique identifier of the project column */ readonly id: number; /** @description Name of the project column */ readonly name: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly project_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -38119,37 +39828,47 @@ export type components = { readonly owner: components["schemas"]["simple-user"]; readonly creator: components["schemas"]["simple-user"]; readonly title: string; + /** @nullable */ readonly description: string | null; readonly public: boolean; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly updated_at: string; readonly number: number; + /** @nullable */ readonly short_description: string | null; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly deleted_at: string | null; readonly deleted_by: components["schemas"]["nullable-simple-user"]; }; readonly webhooks_project_changes: { readonly archived_at?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly from?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly to?: string | null; }; }; @@ -38171,18 +39890,19 @@ export type components = { readonly content_type: components["schemas"]["projects-v2-item-content-type"]; readonly creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly archived_at: string | null; }; @@ -38193,7 +39913,9 @@ export type components = { readonly "projects-v2-single-select-option": { readonly id: string; readonly name: string; + /** @nullable */ readonly color?: string | null; + /** @nullable */ readonly description?: string | null; }; /** @@ -38203,7 +39925,9 @@ export type components = { readonly "projects-v2-iteration-setting": { readonly id: string; readonly title: string; + /** @nullable */ readonly duration?: number | null; + /** @nullable */ readonly start_date?: string | null; }; /** @@ -38216,28 +39940,32 @@ export type components = { readonly project_node_id?: string; readonly creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly updated_at: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** - * Format: date * @example 2022-04-28 + * @format date */ readonly start_date?: string; /** - * Format: date * @example 2022-04-28 + * @format date */ readonly target_date?: string; /** + * @nullable * @description Body of the status update * @example The project is off to a great start! */ @@ -38299,120 +40027,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -38423,48 +40159,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -38505,32 +40252,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -38540,28 +40287,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -38589,37 +40337,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -38640,55 +40396,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -38702,11 +40465,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -38729,26 +40494,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -38763,60 +40528,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -38851,32 +40624,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -38886,28 +40659,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -38935,37 +40709,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -38986,55 +40768,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -39048,11 +40837,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -39075,26 +40866,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -39109,168 +40900,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -39283,73 +41101,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -39358,12 +41185,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -39371,36 +41198,43 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -39409,12 +41243,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -39422,69 +41256,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -39497,17 +41335,17 @@ export type components = { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -39521,20 +41359,23 @@ export type components = { readonly body: string; /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The diff of the line that the comment refers to. */ readonly diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ readonly html_url: string; /** @description The ID of the pull request review comment. */ readonly id: number; /** @description The comment ID to reply to. */ readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the pull request review comment. */ readonly node_id: string; @@ -39544,17 +41385,26 @@ export type components = { readonly original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ readonly path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ readonly pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ readonly pull_request_url: string; /** Reactions */ @@ -39568,7 +41418,7 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -39576,9 +41426,13 @@ export type components = { * @enum {string} */ readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -39589,49 +41443,53 @@ export type components = { * @enum {string} */ readonly subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -39641,12 +41499,12 @@ export type components = { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -39656,60 +41514,71 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ readonly body: string | null; /** @description A commit SHA for the review. */ readonly commit_id: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the review */ readonly id: number; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly pull_request_url: string; readonly state: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly submitted_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly webhooks_nullable_string: string | null; /** * Release @@ -39717,13 +41586,14 @@ export type components = { */ readonly webhooks_release: { readonly assets: readonly { - /** Format: uri */ + /** @format uri */ readonly browser_download_url: string; readonly content_type: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly download_count: number; readonly id: number; + /** @nullable */ readonly label: string | null; /** @description The file name of the asset. */ readonly name: string; @@ -39734,103 +41604,119 @@ export type components = { * @enum {string} */ readonly state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly uploader?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; - /** Format: uri */ + /** @format uri */ readonly assets_url: string; - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: uri */ + /** @format uri */ readonly discussion_url?: string; /** @description Whether the release is a draft or published */ readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ readonly prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly published_at: string | null; /** Reactions */ readonly reactions?: { @@ -39843,20 +41729,26 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @description The name of the tag. */ readonly tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ readonly target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ readonly upload_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly zipball_url: string | null; }; /** @@ -39865,13 +41757,14 @@ export type components = { */ readonly webhooks_release_1: { readonly assets: readonly ({ - /** Format: uri */ + /** @format uri */ readonly browser_download_url: string; readonly content_type: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly download_count: number; readonly id: number; + /** @nullable */ readonly label: string | null; /** @description The file name of the asset. */ readonly name: string; @@ -39882,103 +41775,119 @@ export type components = { * @enum {string} */ readonly state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly uploader?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ readonly assets_url: string; - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: uri */ + /** @format uri */ readonly discussion_url?: string; /** @description Whether the release is a draft or published */ readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ readonly prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly published_at: string | null; /** Reactions */ readonly reactions?: { @@ -39991,20 +41900,26 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @description The name of the tag. */ readonly tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ readonly target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ readonly upload_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly zipball_url: string | null; }; /** @@ -40017,48 +41932,55 @@ export type components = { readonly created_at: string; readonly dismiss_reason?: string; readonly dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ readonly dismisser?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_reference: string | null; readonly fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ readonly fixed_at?: string; readonly fixed_in?: string; readonly ghsa_id: string; @@ -40070,6 +41992,7 @@ export type components = { readonly state: "open"; }; /** + * @nullable * @description The reason for resolving the alert. * @enum {string|null} */ @@ -40081,18 +42004,22 @@ export type components = { readonly url?: components["schemas"]["alert-url"]; readonly html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ readonly locations_url?: string; readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly resolved_at?: string | null; readonly resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ readonly resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; @@ -40106,33 +42033,51 @@ export type components = { * @enum {string} */ readonly validity?: "active" | "inactive" | "unknown"; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ readonly push_protection_bypassed?: boolean | null; readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly push_protection_bypassed_at?: string | null; readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ readonly push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ readonly push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ readonly push_protection_bypass_request_html_url?: string | null; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ readonly publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or business. + */ readonly multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ readonly webhooks_security_advisory: { readonly cvss: { readonly score: number; + /** @nullable */ readonly vector_string: string | null; }; readonly cvss_severities?: components["schemas"]["cvss-severities"]; @@ -40148,13 +42093,14 @@ export type components = { }[]; readonly published_at: string; readonly references: readonly { - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly severity: string; readonly summary: string; readonly updated_at: string; readonly vulnerabilities: readonly { + /** @nullable */ readonly first_patched_version: { readonly identifier: string; } | null; @@ -40165,6 +42111,7 @@ export type components = { readonly severity: string; readonly vulnerable_version_range: string; }[]; + /** @nullable */ readonly withdrawn_at: string | null; }; readonly webhooks_sponsorship: { @@ -40192,79 +42139,87 @@ export type components = { }; readonly node_id: string; readonly privacy_level: string; - /** User */ + /** + * User + * @nullable + */ readonly sponsor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** User */ + /** + * User + * @nullable + */ readonly sponsorable: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -40311,25 +42266,32 @@ export type components = { */ readonly webhooks_team_1: { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -40343,12 +42305,12 @@ export type components = { * @enum {string} */ readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -40361,12 +42323,12 @@ export type components = { * @enum {string} */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }; @@ -40419,15 +42381,18 @@ export type components = { /** @description If the action was `edited`, the changes to the rule. */ readonly changes?: { readonly admin_enforced?: { + /** @nullable */ readonly from: boolean | null; }; readonly authorized_actor_names?: { readonly from: readonly string[]; }; readonly authorized_actors_only?: { + /** @nullable */ readonly from: boolean | null; }; readonly authorized_dismissal_actors_only?: { + /** @nullable */ readonly from: boolean | null; }; readonly linear_history_requirement_enforcement_level?: { @@ -40439,6 +42404,7 @@ export type components = { readonly from: "off" | "non_admins" | "everyone"; }; readonly lock_allows_fork_sync?: { + /** @nullable */ readonly from: boolean | null; }; readonly pull_request_reviews_enforcement_level?: { @@ -40446,6 +42412,7 @@ export type components = { readonly from: "off" | "non_admins" | "everyone"; }; readonly require_last_push_approval?: { + /** @nullable */ readonly from: boolean | null; }; readonly required_status_checks?: { @@ -40546,63 +42513,81 @@ export type components = { readonly action: "completed"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ readonly check_suite: { + /** @nullable */ readonly after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; - /** @description The client ID of the GitHub app */ + /** + * @nullable + * @description The client ID of the GitHub app + */ readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -40681,20 +42666,28 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; }; + /** @nullable */ readonly before: string | null; - /** Format: uri */ + /** @format uri */ readonly check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -40703,9 +42696,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -40716,9 +42712,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -40742,7 +42741,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -40753,28 +42752,29 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly rerequestable?: boolean; readonly runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ readonly url: string; }; @@ -40790,63 +42790,81 @@ export type components = { readonly action: "requested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ readonly check_suite: { + /** @nullable */ readonly after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; - /** @description Client ID of the GitHub app */ + /** + * @nullable + * @description Client ID of the GitHub app + */ readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -40925,20 +42943,28 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; }; + /** @nullable */ readonly before: string | null; - /** Format: uri */ + /** @format uri */ readonly check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -40947,9 +42973,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -40960,9 +42989,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -40986,7 +43018,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -40997,28 +43029,29 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly rerequestable?: boolean; readonly runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ readonly url: string; }; @@ -41034,63 +43067,81 @@ export type components = { readonly action: "rerequested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ readonly check_suite: { + /** @nullable */ readonly after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; - /** @description The Client ID for the GitHub app */ + /** + * @nullable + * @description The Client ID for the GitHub app + */ readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -41169,20 +43220,28 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; }; + /** @nullable */ readonly before: string | null; - /** Format: uri */ + /** @format uri */ readonly check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -41191,9 +43250,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -41204,9 +43266,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -41230,7 +43295,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -41241,28 +43306,29 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly rerequestable?: boolean; readonly runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ readonly url: string; }; @@ -41279,67 +43345,79 @@ export type components = { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly dismissed_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41375,12 +43453,14 @@ export type components = { /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41388,10 +43468,13 @@ export type components = { readonly tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41409,67 +43492,78 @@ export type components = { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ readonly dismissed_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41503,17 +43597,23 @@ export type components = { /** @description A short description of the rule used to detect the alert. */ readonly description: string; readonly full_description?: string; + /** @nullable */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ readonly tags?: readonly string[] | null; }; /** @@ -41522,13 +43622,17 @@ export type components = { */ readonly state: "dismissed" | "fixed"; readonly tool: { + /** @nullable */ readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41546,25 +43650,39 @@ export type components = { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time + * @nullable * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly dismissed_at: unknown; + /** @nullable */ readonly dismissed_by: unknown; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ readonly dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; readonly instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41598,33 +43716,46 @@ export type components = { /** @description A short description of the rule used to detect the alert. */ readonly description: string; readonly full_description?: string; + /** @nullable */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ readonly tags?: readonly string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ readonly state: "open" | "dismissed" | null; + /** @nullable */ readonly tool: { + /** @nullable */ readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; } | null; + /** @nullable */ readonly updated_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41642,69 +43773,81 @@ export type components = { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly dismissed_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41738,32 +43881,43 @@ export type components = { /** @description A short description of the rule used to detect the alert. */ readonly description: string; readonly full_description?: string; + /** @nullable */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ readonly tags?: readonly string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ readonly state: "fixed" | null; readonly tool: { + /** @nullable */ readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41778,27 +43932,43 @@ export type components = { readonly "webhook-code-scanning-alert-reopened": { /** @enum {string} */ readonly action: "reopened"; - /** @description The code scanning alert involved in the event. */ + /** + * @nullable + * @description The code scanning alert involved in the event. + */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly dismissed_at: string | null; + /** @nullable */ readonly dismissed_by: Record | null; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ readonly dismissed_reason: string | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41832,40 +44002,57 @@ export type components = { /** @description A short description of the rule used to detect the alert. */ readonly description: string; readonly full_description?: string; + /** @nullable */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ readonly tags?: readonly string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ readonly state: "open" | "dismissed" | "fixed" | null; readonly tool: { + /** @nullable */ readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ readonly commit_oid: string | null; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ readonly ref: string | null; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; @@ -41877,24 +44064,37 @@ export type components = { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly dismissed_at: unknown; + /** @nullable */ readonly dismissed_by: unknown; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ readonly dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41930,12 +44130,14 @@ export type components = { /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41943,10 +44145,13 @@ export type components = { readonly tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41977,17 +44182,26 @@ export type components = { /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description The ID of the commit comment. */ readonly id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the commit comment. */ readonly node_id: string; - /** @description The relative path of the file to which the comment applies. */ + /** + * @nullable + * @description The relative path of the file to which the comment applies. + */ readonly path: string | null; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; /** Reactions */ readonly reactions?: { @@ -42000,48 +44214,52 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -42054,7 +44272,10 @@ export type components = { }; /** create event */ readonly "webhook-create": { - /** @description The repository's current description. */ + /** + * @nullable + * @description The repository's current description. + */ readonly description: string | null; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; @@ -42242,44 +44463,49 @@ export type components = { */ readonly deployment: { readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; readonly environment: string; readonly id: number; @@ -42288,58 +44514,73 @@ export type components = { readonly payload: Record | string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -42418,20 +44659,23 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly production_environment?: boolean; readonly ref: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly task: string; readonly transient_environment?: boolean; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -42440,43 +44684,50 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -42485,13 +44736,17 @@ export type components = { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly display_title: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: unknown; readonly head_repository?: { readonly archive_url?: string; @@ -42505,6 +44760,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: unknown; readonly downloads_url?: string; readonly events_url?: string; @@ -42561,7 +44817,7 @@ export type components = { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -42569,6 +44825,7 @@ export type components = { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: unknown; readonly pull_requests: readonly { readonly base: { @@ -42577,7 +44834,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -42588,16 +44845,17 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -42615,6 +44873,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: unknown; readonly downloads_url?: string; readonly events_url?: string; @@ -42673,51 +44932,55 @@ export type components = { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -42732,8 +44995,8 @@ export type components = { /** @description The event that triggered the deployment protection rule. */ readonly event?: string; /** - * Format: uri * @description The URL to review the deployment protection rule. + * @format uri */ readonly deployment_callback_url?: string; readonly deployment?: components["schemas"]["deployment"]; @@ -42757,52 +45020,61 @@ export type components = { readonly since: string; readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; readonly workflow_job_runs?: readonly { + /** @nullable */ readonly conclusion?: unknown; readonly created_at?: string; readonly environment?: string; readonly html_url?: string; readonly id?: number; + /** @nullable */ readonly name?: string | null; readonly status?: string; readonly updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -42811,13 +45083,17 @@ export type components = { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly display_title: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: Record | null; readonly head_repository?: { readonly archive_url?: string; @@ -42831,6 +45107,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -42888,7 +45165,7 @@ export type components = { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -42896,6 +45173,7 @@ export type components = { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: string | null; readonly pull_requests: readonly { readonly base: { @@ -42904,7 +45182,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -42915,16 +45193,17 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -42942,6 +45221,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43001,51 +45281,55 @@ export type components = { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -43065,52 +45349,61 @@ export type components = { readonly since: string; readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; readonly workflow_job_runs?: readonly { + /** @nullable */ readonly conclusion?: string | null; readonly created_at?: string; readonly environment?: string; readonly html_url?: string; readonly id?: number; + /** @nullable */ readonly name?: string | null; readonly status?: string; readonly updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -43119,12 +45412,16 @@ export type components = { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: Record | null; readonly head_repository?: { readonly archive_url?: string; @@ -43138,6 +45435,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43195,7 +45493,7 @@ export type components = { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -43203,6 +45501,7 @@ export type components = { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: string | null; readonly pull_requests: readonly { readonly base: { @@ -43211,7 +45510,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -43222,16 +45521,17 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -43249,6 +45549,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43308,51 +45609,55 @@ export type components = { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -43369,41 +45674,45 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly requestor: components["schemas"]["webhooks_user"]; readonly reviewers: readonly { - /** User */ + /** + * User + * @nullable + */ readonly reviewer?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login?: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -43413,52 +45722,61 @@ export type components = { readonly sender: components["schemas"]["simple-user"]; readonly since: string; readonly workflow_job_run: { + /** @nullable */ readonly conclusion: unknown; readonly created_at: string; readonly environment: string; readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly status: string; readonly updated_at: string; }; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -43467,12 +45785,16 @@ export type components = { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: Record | null; readonly head_repository?: { readonly archive_url?: string; @@ -43486,6 +45808,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43543,7 +45866,7 @@ export type components = { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -43551,6 +45874,7 @@ export type components = { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: string | null; readonly pull_requests: readonly { readonly base: { @@ -43559,7 +45883,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -43570,16 +45894,17 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -43597,6 +45922,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43656,51 +45982,55 @@ export type components = { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -43711,34 +46041,39 @@ export type components = { readonly "webhook-deployment-status-created": { /** @enum {string} */ readonly action: "created"; + /** @nullable */ readonly check_run?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly completed_at: string | null; /** + * @nullable * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ + /** @format uri */ readonly details_url: string; readonly external_id: string; /** @description The SHA of the commit that is being checked. */ readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description The id of the check. */ readonly id: number; /** @description The name of the check run. */ readonly name: string; readonly node_id: string; - /** Format: date-time */ + /** @format date-time */ readonly started_at: string; /** * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; /** @@ -43747,104 +46082,125 @@ export type components = { */ readonly deployment: { readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; readonly environment: string; readonly id: number; readonly node_id: string; readonly original_environment: string; + /** @nullable */ readonly payload: (string | Record) | null; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -43923,128 +46279,150 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly production_environment?: boolean; readonly ref: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly task: string; readonly transient_environment?: boolean; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ readonly deployment_status: { readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly deployment_url: string; /** @description The optional human-readable description added to the status. */ readonly description: string; readonly environment: string; - /** Format: uri */ + /** @format uri */ readonly environment_url?: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly log_url?: string; readonly node_id: string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -44123,17 +46501,20 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ readonly state: string; /** @description The optional link added to the status. */ readonly target_url: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -44142,43 +46523,50 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow?: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run?: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -44187,13 +46575,17 @@ export type components = { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly display_title: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: unknown; readonly head_repository?: { readonly archive_url?: string; @@ -44207,6 +46599,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: unknown; readonly downloads_url?: string; readonly events_url?: string; @@ -44263,7 +46656,7 @@ export type components = { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -44271,6 +46664,7 @@ export type components = { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: unknown; readonly pull_requests: readonly { readonly base: { @@ -44279,7 +46673,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -44290,16 +46684,17 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -44317,6 +46712,7 @@ export type components = { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: unknown; readonly downloads_url?: string; readonly events_url?: string; @@ -44375,51 +46771,55 @@ export type components = { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -44444,7 +46844,7 @@ export type components = { readonly changes: { readonly category: { readonly from: { - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly description: string; readonly emoji: string; @@ -44693,32 +47093,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -44728,28 +47128,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -44772,89 +47173,104 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -44868,36 +47284,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -44922,6 +47340,7 @@ export type components = { readonly created_at?: string; readonly default_branch?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly disabled?: boolean; readonly downloads_url?: string; @@ -44941,6 +47360,7 @@ export type components = { readonly has_pages?: boolean; readonly has_projects?: boolean; readonly has_wiki?: boolean; + /** @nullable */ readonly homepage?: string | null; readonly hooks_url?: string; readonly html_url?: string; @@ -44951,11 +47371,14 @@ export type components = { readonly issues_url?: string; readonly keys_url?: string; readonly labels_url?: string; + /** @nullable */ readonly language?: unknown; readonly languages_url?: string; + /** @nullable */ readonly license?: Record | null; readonly merges_url?: string; readonly milestones_url?: string; + /** @nullable */ readonly mirror_url?: unknown; readonly name?: string; readonly node_id?: string; @@ -45029,14 +47452,15 @@ export type components = { */ readonly action: "created" | "edited"; /** - * Format: uri * @description Points to the HTML wiki page. + * @format uri */ readonly html_url: string; /** @description The name of the page. */ readonly page_name: string; /** @description The latest commit SHA of the page. */ readonly sha: string; + /** @nullable */ readonly summary: string | null; /** @description The current page title. */ readonly title: string; @@ -45065,6 +47489,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ readonly requester?: unknown; readonly sender: components["schemas"]["simple-user"]; }; @@ -45077,6 +47502,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ readonly requester?: unknown; readonly sender: components["schemas"]["simple-user"]; }; @@ -45137,14 +47563,17 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ readonly requester?: unknown; readonly sender: components["schemas"]["simple-user"]; }; readonly "webhook-installation-target-renamed": { readonly account: { + /** @nullable */ readonly archived_at?: string | null; readonly avatar_url: string; readonly created_at?: string; + /** @nullable */ readonly description?: unknown; readonly events_url?: string; readonly followers?: number; @@ -45177,6 +47606,7 @@ export type components = { readonly type?: string; readonly updated_at?: string; readonly url?: string; + /** @nullable */ readonly website_url?: unknown; readonly user_view_type?: string; }; @@ -45206,6 +47636,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ readonly requester?: unknown; readonly sender: components["schemas"]["simple-user"]; }; @@ -45226,16 +47657,16 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ readonly body: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly node_id: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -45250,52 +47681,56 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -45304,80 +47739,88 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -45387,95 +47830,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -45488,67 +47950,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -45627,19 +48104,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -45653,10 +48136,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -45669,100 +48152,112 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; } & { + /** @nullable */ readonly active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees?: readonly (Record | null)[]; readonly author_association?: string; + /** @nullable */ readonly body?: string | null; + /** @nullable */ readonly closed_at?: string | null; readonly comments?: number; readonly comments_url?: string; @@ -45774,22 +48269,25 @@ export type components = { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly labels_url?: string; readonly locked: boolean; + /** @nullable */ readonly milestone?: Record | null; readonly node_id?: string; readonly number?: number; + /** @nullable */ readonly performed_via_github_app?: Record | null; readonly reactions?: { readonly "+1"?: number; @@ -45821,7 +48319,7 @@ export type components = { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -45848,80 +48346,88 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -45931,95 +48437,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -46032,67 +48557,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -46171,19 +48711,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -46197,10 +48743,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -46213,100 +48759,112 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; } & { + /** @nullable */ readonly active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees?: readonly (Record | null)[]; readonly author_association?: string; + /** @nullable */ readonly body?: string | null; + /** @nullable */ readonly closed_at?: string | null; readonly comments?: number; readonly comments_url?: string; @@ -46318,22 +48876,25 @@ export type components = { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly labels_url?: string; readonly locked: boolean; + /** @nullable */ readonly milestone?: Record | null; readonly node_id?: string; readonly number?: number; + /** @nullable */ readonly performed_via_github_app?: Record | null; readonly reactions?: { readonly "+1"?: number; @@ -46365,7 +48926,7 @@ export type components = { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -46394,80 +48955,88 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -46477,95 +49046,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -46578,67 +49166,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -46717,19 +49320,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -46743,10 +49352,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -46759,100 +49368,112 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; } & { + /** @nullable */ readonly active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees?: readonly (Record | null)[]; readonly author_association?: string; + /** @nullable */ readonly body?: string | null; + /** @nullable */ readonly closed_at?: string | null; readonly comments?: number; readonly comments_url?: string; @@ -46864,22 +49485,25 @@ export type components = { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly labels_url?: string; readonly locked: boolean; + /** @nullable */ readonly milestone?: Record | null; readonly node_id?: string; readonly number?: number; + /** @nullable */ readonly performed_via_github_app?: Record | null; readonly reactions?: { readonly "+1"?: number; @@ -46911,7 +49535,7 @@ export type components = { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -46955,80 +49579,88 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -47038,95 +49670,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -47139,67 +49790,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -47278,19 +49944,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -47304,10 +49976,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -47320,63 +49992,72 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; } & { + /** @nullable */ readonly active_lock_reason?: string | null; + /** @nullable */ readonly assignee?: Record | null; readonly assignees?: readonly (Record | null)[]; readonly author_association?: string; + /** @nullable */ readonly body?: string | null; + /** @nullable */ readonly closed_at: string | null; readonly comments?: number; readonly comments_url?: string; @@ -47387,9 +50068,11 @@ export type components = { readonly labels?: readonly (Record | null)[]; readonly labels_url?: string; readonly locked?: boolean; + /** @nullable */ readonly milestone?: Record | null; readonly node_id?: string; readonly number?: number; + /** @nullable */ readonly performed_via_github_app?: Record | null; readonly reactions?: { readonly "+1"?: number; @@ -47418,7 +50101,7 @@ export type components = { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -47448,80 +50131,88 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -47530,95 +50221,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -47631,67 +50341,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -47770,19 +50495,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -47796,10 +50527,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -47812,54 +50543,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -47879,79 +50615,87 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -47960,95 +50704,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -48061,67 +50824,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -48200,19 +50978,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -48226,10 +51010,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -48242,54 +51026,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -48321,80 +51110,88 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -48403,95 +51200,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -48504,67 +51320,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -48643,19 +51474,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -48669,10 +51506,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -48685,54 +51522,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -48753,80 +51595,88 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -48835,95 +51685,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -48936,67 +51805,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49075,19 +51959,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -49101,10 +51991,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -49117,54 +52007,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49185,80 +52080,88 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -49268,96 +52171,115 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; /** @enum {boolean} */ readonly locked: true; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -49370,67 +52292,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49509,19 +52446,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -49535,10 +52478,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -49551,54 +52494,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49618,79 +52566,87 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -49699,95 +52655,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -49800,67 +52775,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49939,19 +52929,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -49965,10 +52961,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -49981,54 +52977,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -50045,83 +53046,92 @@ export type components = { readonly changes?: { /** * Issue + * @nullable * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly old_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -50131,95 +53141,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -50232,67 +53261,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -50371,19 +53415,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -50397,10 +53447,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -50413,54 +53463,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -50493,32 +53548,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -50532,28 +53587,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** @description Whether the repository has discussions enabled. */ readonly has_discussions?: boolean; @@ -50578,89 +53634,104 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -50674,36 +53745,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -50720,80 +53793,88 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -50803,95 +53884,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -50904,67 +54004,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51043,19 +54158,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -51069,10 +54190,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -51085,54 +54206,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51163,79 +54289,87 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -51244,95 +54378,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -51345,67 +54498,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51484,19 +54652,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -51510,10 +54684,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -51526,54 +54700,59 @@ export type components = { * @enum {string} */ readonly state: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51592,80 +54771,88 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly new_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -51675,95 +54862,114 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -51776,67 +54982,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51915,19 +55136,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -51941,10 +55168,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -51957,54 +55184,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -52037,32 +55269,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -52076,28 +55308,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -52125,89 +55358,104 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -52221,36 +55469,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -52305,80 +55555,88 @@ export type components = { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -52388,96 +55646,115 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; /** @enum {boolean} */ readonly locked: false; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -52490,67 +55767,82 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -52629,19 +55921,25 @@ export type components = { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -52655,10 +55953,10 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -52671,54 +55969,59 @@ export type components = { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -52814,12 +56117,16 @@ export type components = { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: string | null; + /** @nullable */ readonly next_billing_date?: string | null; + /** @nullable */ readonly on_free_trial: boolean | null; readonly plan: { readonly bullets: readonly string[]; @@ -52830,6 +56137,7 @@ export type components = { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -52853,11 +56161,14 @@ export type components = { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: string | null; + /** @nullable */ readonly next_billing_date?: string | null; readonly on_free_trial: boolean; readonly plan: { @@ -52869,6 +56180,7 @@ export type components = { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -52890,11 +56202,14 @@ export type components = { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: unknown; + /** @nullable */ readonly next_billing_date: string | null; readonly on_free_trial: boolean; readonly plan: { @@ -52906,6 +56221,7 @@ export type components = { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -52967,7 +56283,9 @@ export type components = { readonly from: string; }; readonly permission?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; }; @@ -53003,41 +56321,45 @@ export type components = { * @enum {string} */ readonly scope: "team"; - /** User */ + /** + * User + * @nullable + */ readonly sender: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -53057,41 +56379,45 @@ export type components = { * @enum {string} */ readonly scope: "team" | "organization"; - /** User */ + /** + * User + * @nullable + */ readonly sender: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -53133,7 +56459,7 @@ export type components = { readonly content_type: "json" | "form"; readonly insecure_ssl: string; readonly secret?: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly created_at: string; @@ -53272,53 +56598,63 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ readonly invitation: { - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; + /** @nullable */ readonly email: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly failed_at: string | null; + /** @nullable */ readonly failed_reason: string | null; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly invitation_teams_url: string; - /** User */ + /** + * User + * @nullable + */ readonly inviter: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly login: string | null; readonly node_id: string; readonly role: string; @@ -53385,96 +56721,110 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ readonly package: { + /** @nullable */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; readonly ecosystem: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly name: string; readonly namespace: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly package_type: string; + /** @nullable */ readonly package_version: { - /** User */ + /** + * User + * @nullable + */ readonly author?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly body?: string | Record; readonly body_html?: string; + /** @nullable */ readonly container_metadata?: { + /** @nullable */ readonly labels?: Record | null; + /** @nullable */ readonly manifest?: Record | null; readonly tag?: { readonly digest?: string; @@ -53487,7 +56837,7 @@ export type components = { readonly tags?: readonly string[]; }[]; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly installation_command: string; @@ -53496,22 +56846,27 @@ export type components = { readonly [key: string]: unknown; }[]; readonly name: string; + /** @nullable */ readonly npm_metadata?: { readonly name?: string; readonly version?: string; readonly npm_user?: string; + /** @nullable */ readonly author?: Record | null; + /** @nullable */ readonly bugs?: Record | null; readonly dependencies?: Record; readonly dev_dependencies?: Record; readonly peer_dependencies?: Record; readonly optional_dependencies?: Record; readonly description?: string; + /** @nullable */ readonly dist?: Record | null; readonly git_head?: string; readonly homepage?: string; readonly license?: string; readonly main?: string; + /** @nullable */ readonly repository?: Record | null; readonly scripts?: Record; readonly id?: string; @@ -53525,6 +56880,7 @@ export type components = { readonly files?: readonly string[]; readonly bin?: Record; readonly man?: Record; + /** @nullable */ readonly directories?: Record | null; readonly os?: readonly string[]; readonly cpu?: readonly string[]; @@ -53535,6 +56891,7 @@ export type components = { readonly published_via_actions?: boolean; readonly deleted_by_id?: number; } | null; + /** @nullable */ readonly nuget_metadata?: readonly { readonly id?: number | string; readonly name?: string; @@ -53548,69 +56905,78 @@ export type components = { readonly package_files: readonly { readonly content_type: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly download_url: string; readonly id: number; + /** @nullable */ readonly md5: string | null; readonly name: string; + /** @nullable */ readonly sha1: string | null; + /** @nullable */ readonly sha256: string | null; readonly size: number; + /** @nullable */ readonly state: string | null; readonly updated_at: string; }[]; readonly package_url?: string; readonly prerelease?: boolean; readonly release?: { - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly created_at: string; readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly prerelease: boolean; readonly published_at: string; readonly tag_name: string; readonly target_commitish: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; @@ -53622,15 +56988,17 @@ export type components = { readonly updated_at?: string; readonly version: string; } | null; + /** @nullable */ readonly registry: { - /** Format: uri */ + /** @format uri */ readonly about_url: string; readonly name: string; readonly type: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly vendor: string; } | null; + /** @nullable */ readonly updated_at: string | null; }; readonly repository?: components["schemas"]["repository-webhooks"]; @@ -53646,88 +57014,97 @@ export type components = { /** @description Information about the package. */ readonly package: { readonly created_at: string; + /** @nullable */ readonly description: string | null; readonly ecosystem: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly name: string; readonly namespace: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly package_type: string; readonly package_version: { - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -53739,7 +57116,7 @@ export type components = { readonly tags?: readonly string[]; }[]; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly installation_command: string; @@ -53751,11 +57128,13 @@ export type components = { readonly package_files: readonly { readonly content_type: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly download_url: string; readonly id: number; + /** @nullable */ readonly md5: string | null; readonly name: string; + /** @nullable */ readonly sha1: string | null; readonly sha256: string; readonly size: number; @@ -53765,47 +57144,51 @@ export type components = { readonly package_url?: string; readonly prerelease?: boolean; readonly release?: { - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly created_at: string; readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly name: string; @@ -53813,11 +57196,11 @@ export type components = { readonly published_at: string; readonly tag_name: string; readonly target_commitish: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; - /** Format: uri */ + /** @format uri */ readonly source_url?: string; readonly summary: string; readonly tag_name?: string; @@ -53826,12 +57209,13 @@ export type components = { readonly updated_at: string; readonly version: string; }; + /** @nullable */ readonly registry: { - /** Format: uri */ + /** @format uri */ readonly about_url: string; readonly name: string; readonly type: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly vendor: string; } | null; @@ -53844,53 +57228,59 @@ export type components = { readonly "webhook-page-build": { /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ readonly build: { + /** @nullable */ readonly commit: string | null; readonly created_at: string; readonly duration: number; readonly error: { + /** @nullable */ readonly message: string | null; }; - /** User */ + /** + * User + * @nullable + */ readonly pusher: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly status: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -53956,9 +57346,9 @@ export type components = { readonly secret?: components["schemas"]["webhook-config-secret"]; readonly url?: components["schemas"]["webhook-config-url"]; }; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly deliveries_url?: string; /** @description Determines what events the hook is triggered for. Default: ['push']. */ readonly events: readonly string[]; @@ -53970,14 +57360,14 @@ export type components = { * @enum {string} */ readonly name: "web"; - /** Format: uri */ + /** @format uri */ readonly ping_url?: string; - /** Format: uri */ + /** @format uri */ readonly test_url?: string; readonly type: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** @description The ID of the webhook that triggered the ping. */ @@ -54029,63 +57419,70 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ readonly project_card: { + /** @nullable */ readonly after_id?: number | null; /** @description Whether or not the card is archived */ readonly archived: boolean; + /** @nullable */ readonly column_id: number | null; - /** Format: uri */ + /** @format uri */ readonly column_url: string; - /** Format: uri */ + /** @format uri */ readonly content_url?: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; readonly node_id: string; + /** @nullable */ readonly note: string | null; - /** Format: uri */ + /** @format uri */ readonly project_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; @@ -54097,6 +57494,7 @@ export type components = { readonly action: "edited"; readonly changes: { readonly note: { + /** @nullable */ readonly from: string | null; }; }; @@ -54120,70 +57518,78 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_card: { + /** @nullable */ readonly after_id?: number | null; /** @description Whether or not the card is archived */ readonly archived: boolean; readonly column_id: number; - /** Format: uri */ + /** @format uri */ readonly column_url: string; - /** Format: uri */ + /** @format uri */ readonly content_url?: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; readonly node_id: string; + /** @nullable */ readonly note: string | null; - /** Format: uri */ + /** @format uri */ readonly project_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } & { + /** @nullable */ readonly after_id: number | null; readonly archived?: boolean; readonly column_id?: number; readonly column_url?: string; readonly created_at?: string; + /** @nullable */ readonly creator?: { readonly avatar_url?: string; readonly events_url?: string; @@ -54206,6 +57612,7 @@ export type components = { } | null; readonly id?: number; readonly node_id?: string; + /** @nullable */ readonly note?: string | null; readonly project_url?: string; readonly updated_at?: string; @@ -54362,7 +57769,9 @@ export type components = { readonly action: "edited"; readonly changes: { readonly description?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; readonly public?: { @@ -54370,7 +57779,9 @@ export type components = { readonly to?: boolean; }; readonly short_description?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; readonly title?: { @@ -54399,6 +57810,7 @@ export type components = { readonly action: "converted"; readonly changes: { readonly content_type?: { + /** @nullable */ readonly from?: string | null; readonly to?: string; }; @@ -54440,12 +57852,16 @@ export type components = { readonly field_type?: string; readonly field_name?: string; readonly project_number?: number; + /** @nullable */ readonly from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + /** @nullable */ readonly to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; }; } | { readonly body: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; }; @@ -54460,7 +57876,9 @@ export type components = { readonly action: "reordered"; readonly changes: { readonly previous_projects_v2_item_node_id?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; }; @@ -54512,25 +57930,45 @@ export type components = { readonly action: "edited"; readonly changes?: { readonly body?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; readonly status?: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; readonly start_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ readonly from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ readonly to?: string | null; }; readonly target_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ readonly from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ readonly to?: string | null; }; }; @@ -54561,120 +57999,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -54686,48 +58132,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -54768,32 +58225,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -54803,28 +58260,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -54852,37 +58310,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -54903,55 +58369,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -54965,11 +58438,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -54992,26 +58467,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55026,68 +58501,78 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -55114,32 +58599,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -55149,28 +58634,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -55198,37 +58684,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -55249,55 +58743,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -55311,11 +58812,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -55338,26 +58841,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55372,168 +58875,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -55546,74 +59076,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -55622,12 +59161,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -55635,36 +59174,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -55673,12 +59219,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -55686,69 +59232,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -55769,120 +59319,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -55893,48 +59451,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -55975,32 +59544,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -56010,28 +59579,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -56059,37 +59629,45 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -56110,55 +59688,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -56172,11 +59757,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -56199,26 +59786,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56233,60 +59820,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -56321,32 +59916,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -56356,28 +59951,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -56405,37 +60001,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -56456,55 +60060,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -56518,11 +60129,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -56545,26 +60158,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56579,168 +60192,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -56753,74 +60393,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -56829,12 +60478,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -56842,36 +60491,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -56880,12 +60536,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -56893,69 +60549,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -56977,120 +60637,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -57101,48 +60769,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -57183,32 +60862,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -57218,28 +60897,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -57267,37 +60947,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -57318,55 +61006,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -57380,11 +61075,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -57407,26 +61104,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57441,60 +61138,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -57529,32 +61234,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -57564,28 +61269,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -57613,34 +61319,42 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -57661,55 +61375,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -57723,11 +61444,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -57750,26 +61473,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57784,168 +61507,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -57958,74 +61708,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -58034,12 +61793,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -58047,36 +61806,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -58085,12 +61851,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -58098,69 +61864,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -58218,120 +61988,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -58342,48 +62120,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -58424,32 +62213,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -58459,28 +62248,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -58508,37 +62298,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -58559,55 +62357,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -58621,11 +62426,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -58648,26 +62455,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -58682,60 +62489,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -58770,32 +62585,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -58805,28 +62620,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -58854,37 +62670,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -58905,55 +62729,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -58967,11 +62798,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -58994,26 +62827,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59028,168 +62861,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -59202,74 +63062,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -59278,12 +63147,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -59291,36 +63160,43 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -59329,12 +63205,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -59342,69 +63218,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -59458,120 +63338,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -59582,48 +63470,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -59664,32 +63563,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -59699,28 +63598,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -59748,37 +63648,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -59799,55 +63707,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -59861,11 +63776,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -59888,26 +63805,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59922,60 +63839,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -60010,32 +63935,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -60045,28 +63970,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -60094,37 +64020,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -60145,55 +64079,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -60207,11 +64148,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -60234,26 +64177,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -60268,168 +64211,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -60442,74 +64412,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -60518,12 +64497,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -60531,36 +64510,43 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -60569,12 +64555,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -60582,69 +64568,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -60666,120 +64656,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -60790,48 +64788,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -60872,32 +64881,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -60907,28 +64916,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -60956,37 +64966,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -61007,55 +65025,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -61069,11 +65094,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -61096,26 +65123,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61130,68 +65157,78 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -61218,32 +65255,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -61253,28 +65290,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -61302,37 +65340,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -61353,55 +65399,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -61415,11 +65468,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -61442,26 +65497,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61476,168 +65531,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -61650,74 +65732,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -61726,12 +65817,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -61739,36 +65830,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -61777,12 +65875,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -61790,69 +65888,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -61873,120 +65975,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -61997,48 +66107,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -62079,32 +66200,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -62114,28 +66235,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -62163,37 +66285,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -62214,55 +66344,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -62276,11 +66413,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -62303,26 +66442,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62337,68 +66476,78 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -62425,32 +66574,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -62460,28 +66609,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -62509,37 +66659,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -62560,55 +66718,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -62622,11 +66787,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -62649,26 +66816,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62683,168 +66850,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -62857,74 +67051,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -62933,12 +67136,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -62946,36 +67149,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -62984,12 +67194,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -62997,69 +67207,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -63127,17 +67341,17 @@ export type components = { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -63151,40 +67365,55 @@ export type components = { readonly body: string; /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The diff of the line that the comment refers to. */ readonly diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ readonly html_url: string; /** @description The ID of the pull request review comment. */ readonly id: number; /** @description The comment ID to reply to. */ readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the pull request review comment. */ readonly node_id: string; /** @description The SHA of the original commit to which the comment applies. */ readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ readonly path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ readonly pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ readonly pull_request_url: string; /** Reactions */ @@ -63198,7 +67427,7 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -63206,9 +67435,13 @@ export type components = { * @enum {string} */ readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -63219,49 +67452,53 @@ export type components = { * @enum {string} */ readonly subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -63273,119 +67510,127 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -63396,48 +67641,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -63478,32 +67734,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -63513,28 +67769,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -63562,37 +67819,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -63613,55 +67878,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -63675,11 +67947,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -63702,26 +67976,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -63736,54 +68010,60 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft?: boolean; readonly head: { @@ -63791,6 +68071,7 @@ export type components = { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -63817,32 +68098,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -63852,28 +68133,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -63901,37 +68183,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -63952,55 +68242,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -64014,11 +68311,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -64041,26 +68340,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64075,124 +68374,143 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -64205,72 +68523,80 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -64279,12 +68605,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -64292,36 +68618,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -64330,12 +68663,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -64343,63 +68676,67 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -64419,119 +68756,127 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -64542,48 +68887,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -64624,32 +68980,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -64659,28 +69015,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -64708,37 +69065,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -64759,55 +69124,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -64821,11 +69193,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -64848,26 +69222,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64882,54 +69256,60 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft?: boolean; readonly head: { @@ -64937,6 +69317,7 @@ export type components = { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -64963,32 +69344,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -64998,28 +69379,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -65047,37 +69429,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -65098,55 +69488,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -65160,11 +69557,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -65187,26 +69586,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -65221,124 +69620,143 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -65351,72 +69769,80 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -65425,12 +69851,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -65438,36 +69864,43 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -65476,12 +69909,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -65489,63 +69922,67 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -65566,119 +70003,127 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -65690,48 +70135,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -65772,32 +70228,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -65807,28 +70263,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -65856,37 +70313,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -65907,55 +70372,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -65969,11 +70441,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -65996,26 +70470,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66030,54 +70504,60 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft?: boolean; readonly head: { @@ -66085,6 +70565,7 @@ export type components = { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -66111,32 +70592,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -66146,28 +70627,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -66195,37 +70677,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -66246,55 +70736,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -66308,11 +70805,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -66335,26 +70834,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66369,124 +70868,143 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -66499,72 +71017,80 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -66573,12 +71099,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -66586,36 +71112,43 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -66624,12 +71157,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -66637,64 +71170,68 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; readonly user_view_type?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; }; @@ -66713,119 +71250,127 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -66836,48 +71381,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -66918,32 +71474,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -66953,28 +71509,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -67002,37 +71559,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -67053,55 +71618,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -67115,11 +71687,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -67142,26 +71716,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67176,54 +71750,60 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { @@ -67231,6 +71811,7 @@ export type components = { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -67257,32 +71838,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -67292,28 +71873,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -67341,37 +71923,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -67392,55 +71982,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -67454,11 +72051,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -67481,26 +72080,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67515,124 +72114,143 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -67645,72 +72263,80 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -67719,12 +72345,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -67732,36 +72358,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -67770,12 +72403,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -67783,63 +72416,67 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -67850,12 +72487,12 @@ export type components = { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -67865,57 +72502,64 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ readonly body: string | null; /** @description A commit SHA for the review. */ readonly commit_id: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the review */ readonly id: number; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly pull_request_url: string; /** @enum {string} */ readonly state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ + /** @format date-time */ readonly submitted_at: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -67940,119 +72584,127 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -68063,48 +72715,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -68145,32 +72808,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -68180,28 +72843,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -68224,89 +72888,104 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -68320,36 +72999,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -68357,54 +73038,60 @@ export type components = { readonly watchers_count: number; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { @@ -68412,6 +73099,7 @@ export type components = { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -68438,32 +73126,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -68473,28 +73161,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -68517,89 +73206,104 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -68613,36 +73317,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -68650,124 +73356,143 @@ export type components = { readonly watchers_count: number; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -68780,72 +73505,80 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -68854,12 +73587,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -68867,36 +73600,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -68905,12 +73645,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -68918,63 +73658,67 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -68997,120 +73741,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -69122,48 +73874,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -69204,32 +73967,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -69239,28 +74002,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -69288,37 +74052,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -69339,55 +74111,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -69401,11 +74180,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -69421,26 +74202,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69455,60 +74236,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -69543,32 +74332,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -69578,28 +74367,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -69627,37 +74417,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -69678,55 +74476,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -69740,11 +74545,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -69767,26 +74574,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69801,168 +74608,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -69975,74 +74809,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -70051,12 +74894,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -70064,36 +74907,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -70102,12 +74952,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -70115,109 +74965,117 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ readonly requested_reviewer: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -70235,120 +75093,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -70360,48 +75226,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -70442,32 +75319,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -70477,28 +75354,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -70526,37 +75404,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -70577,55 +75463,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -70639,11 +75532,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -70666,26 +75561,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -70700,60 +75595,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -70788,32 +75691,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -70823,28 +75726,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -70872,37 +75776,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -70923,55 +75835,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -70985,11 +75904,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -71012,26 +75933,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71046,168 +75967,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -71220,74 +76168,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -71296,12 +76253,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -71309,36 +76266,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -71347,12 +76311,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -71360,69 +76324,73 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -71434,25 +76402,32 @@ export type components = { */ readonly requested_team: { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -71461,12 +76436,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -71474,12 +76449,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; }; @@ -71499,120 +76474,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -71624,48 +76607,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -71706,32 +76700,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -71741,28 +76735,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -71790,37 +76785,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -71841,55 +76844,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -71903,11 +76913,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -71930,26 +76942,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71964,60 +76976,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -72052,32 +77072,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -72087,28 +77107,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -72136,37 +77157,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -72187,55 +77216,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -72249,11 +77285,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -72276,26 +77314,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -72310,168 +77348,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -72484,74 +77549,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -72560,12 +77634,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -72573,36 +77647,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -72611,12 +77692,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -72624,109 +77705,117 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ readonly requested_reviewer: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -72744,120 +77833,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -72869,48 +77966,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -72951,32 +78059,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -72986,28 +78094,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -73035,37 +78144,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -73086,55 +78203,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -73148,11 +78272,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -73175,26 +78301,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73209,60 +78335,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -73297,32 +78431,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -73332,28 +78466,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -73381,37 +78516,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -73432,55 +78575,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -73494,11 +78644,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -73521,26 +78673,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73555,168 +78707,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -73729,74 +78908,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -73805,12 +78993,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -73818,36 +79006,43 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -73856,12 +79051,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -73869,69 +79064,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -73943,25 +79142,32 @@ export type components = { */ readonly requested_team: { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -73970,12 +79176,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -73983,12 +79189,12 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }; @@ -74006,119 +79212,127 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -74129,48 +79343,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -74211,32 +79436,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -74246,28 +79471,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -74295,37 +79521,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -74346,55 +79580,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -74408,11 +79649,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -74435,26 +79678,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74469,61 +79712,69 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -74550,32 +79801,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -74585,28 +79836,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -74634,37 +79886,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -74685,55 +79945,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -74747,11 +80014,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -74774,26 +80043,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74808,124 +80077,143 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -74938,72 +80226,80 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -75012,12 +80308,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -75025,36 +80321,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -75063,12 +80366,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -75076,63 +80379,67 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -75153,119 +80460,127 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -75276,48 +80591,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -75358,32 +80684,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -75393,28 +80719,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -75442,89 +80769,104 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -75538,36 +80880,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -75577,61 +80921,69 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -75658,32 +81010,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -75693,28 +81045,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -75742,89 +81095,104 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -75838,36 +81206,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -75877,124 +81247,143 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -76007,72 +81396,80 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -76081,12 +81478,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -76094,36 +81491,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -76132,12 +81536,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -76145,63 +81549,67 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -76213,17 +81621,17 @@ export type components = { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -76237,40 +81645,55 @@ export type components = { readonly body: string; /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The diff of the line that the comment refers to. */ readonly diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ readonly html_url: string; /** @description The ID of the pull request review comment. */ readonly id: number; /** @description The comment ID to reply to. */ readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the pull request review comment. */ readonly node_id: string; /** @description The SHA of the original commit to which the comment applies. */ readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ readonly path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ readonly pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ readonly pull_request_url: string; /** Reactions */ @@ -76284,7 +81707,7 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -76292,9 +81715,13 @@ export type components = { * @enum {string} */ readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -76305,49 +81732,53 @@ export type components = { * @enum {string} */ readonly subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -76367,119 +81798,127 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -76490,48 +81929,56 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ readonly commit_title: string; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -76572,32 +82019,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -76607,28 +82054,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -76656,89 +82104,104 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -76752,36 +82215,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -76791,54 +82256,60 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { @@ -76872,32 +82343,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -76907,28 +82378,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -76956,89 +82428,104 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77052,36 +82539,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -77091,124 +82580,143 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -77221,72 +82729,80 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -77295,12 +82811,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -77308,36 +82824,43 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -77346,12 +82869,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -77359,63 +82882,67 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77427,17 +82954,17 @@ export type components = { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -77451,20 +82978,23 @@ export type components = { readonly body: string; /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The diff of the line that the comment refers to. */ readonly diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ readonly html_url: string; /** @description The ID of the pull request review comment. */ readonly id: number; /** @description The comment ID to reply to. */ readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the pull request review comment. */ readonly node_id: string; @@ -77474,17 +83004,26 @@ export type components = { readonly original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ readonly path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ readonly pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ readonly pull_request_url: string; /** Reactions */ @@ -77498,7 +83037,7 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -77506,9 +83045,13 @@ export type components = { * @enum {string} */ readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -77519,49 +83062,53 @@ export type components = { * @enum {string} */ readonly subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77584,120 +83131,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -77708,48 +83263,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77790,32 +83356,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -77825,28 +83391,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -77874,37 +83441,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -77925,55 +83500,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77987,11 +83569,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -78014,26 +83598,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78048,60 +83632,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -78136,32 +83728,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -78171,28 +83763,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -78220,37 +83813,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -78264,55 +83865,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -78326,11 +83934,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -78353,26 +83963,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78387,168 +83997,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -78561,74 +84198,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -78637,12 +84283,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -78650,36 +84296,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -78688,12 +84341,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -78701,69 +84354,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -78785,120 +84442,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -78909,48 +84574,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -78961,6 +84637,7 @@ export type components = { readonly merge_method: "merge" | "squash" | "rebase"; } | null; readonly base: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** @@ -78991,32 +84668,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -79026,28 +84703,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -79075,37 +84753,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -79126,55 +84812,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -79188,11 +84881,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -79215,26 +84910,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79249,68 +84944,78 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -79337,32 +85042,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -79372,28 +85077,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -79421,37 +85127,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -79472,55 +85186,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -79534,11 +85255,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -79561,26 +85284,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79595,168 +85318,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -79769,74 +85519,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -79845,12 +85604,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -79858,36 +85617,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -79896,12 +85662,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -79909,69 +85675,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -79993,120 +85763,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -80117,48 +85895,59 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -80199,32 +85988,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -80234,28 +86023,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -80283,37 +86073,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -80334,55 +86132,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -80396,11 +86201,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -80423,26 +86230,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80457,68 +86264,78 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -80545,32 +86362,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -80580,28 +86397,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -80629,37 +86447,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -80673,55 +86499,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -80735,11 +86568,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -80762,26 +86597,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80796,168 +86631,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -80970,74 +86832,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -81046,12 +86917,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -81059,36 +86930,43 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -81097,12 +86975,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -81110,69 +86988,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -81193,120 +87075,128 @@ export type components = { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -81317,48 +87207,56 @@ export type components = { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ readonly commit_title: string; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -81399,32 +87297,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -81434,28 +87332,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -81483,37 +87382,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -81534,55 +87441,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -81596,11 +87510,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -81623,26 +87539,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -81657,60 +87573,68 @@ export type components = { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -81719,6 +87643,7 @@ export type components = { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -81745,32 +87670,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -81780,28 +87705,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -81829,37 +87755,45 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -81880,55 +87814,62 @@ export type components = { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -81942,11 +87883,13 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -81969,26 +87912,26 @@ export type components = { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -82003,168 +87946,195 @@ export type components = { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -82177,74 +88147,83 @@ export type components = { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -82253,12 +88232,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -82266,36 +88245,43 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -82304,12 +88290,12 @@ export type components = { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -82317,69 +88303,73 @@ export type components = { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -82403,9 +88393,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -82416,9 +88409,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -82434,14 +88430,14 @@ export type components = { /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ readonly removed?: readonly string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ readonly timestamp: string; readonly tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ readonly url: string; }[]; @@ -82454,7 +88450,10 @@ export type components = { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ readonly forced: boolean; - /** Commit */ + /** + * Commit + * @nullable + */ readonly head_commit: { /** @description An array of files added in the commit. */ readonly added?: readonly string[]; @@ -82463,9 +88462,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -82476,9 +88478,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -82494,14 +88499,14 @@ export type components = { /** @description An array of files removed in the commit. */ readonly removed?: readonly string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ readonly timestamp: string; readonly tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ readonly url: string; } | null; @@ -82512,9 +88517,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly pusher: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email?: string | null; /** @description The git author's name. */ readonly name: string; @@ -82550,32 +88558,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -82589,28 +88597,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -82638,89 +88647,104 @@ export type components = { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -82734,36 +88758,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -82781,7 +88807,9 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly registry_package: { + /** @nullable */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; readonly ecosystem: string; readonly html_url: string; @@ -82810,6 +88838,7 @@ export type components = { readonly user_view_type?: string; }; readonly package_type: string; + /** @nullable */ readonly package_version: { readonly author?: { readonly avatar_url: string; @@ -82835,7 +88864,9 @@ export type components = { readonly body?: string | Record; readonly body_html?: string; readonly container_metadata?: { + /** @nullable */ readonly labels?: Record | null; + /** @nullable */ readonly manifest?: Record | null; readonly tag?: { readonly digest?: string; @@ -82856,22 +88887,27 @@ export type components = { readonly [key: string]: unknown; }[]; readonly name: string; + /** @nullable */ readonly npm_metadata?: { readonly name?: string; readonly version?: string; readonly npm_user?: string; + /** @nullable */ readonly author?: (string | Record) | null; + /** @nullable */ readonly bugs?: (string | Record) | null; readonly dependencies?: Record; readonly dev_dependencies?: Record; readonly peer_dependencies?: Record; readonly optional_dependencies?: Record; readonly description?: string; + /** @nullable */ readonly dist?: (string | Record) | null; readonly git_head?: string; readonly homepage?: string; readonly license?: string; readonly main?: string; + /** @nullable */ readonly repository?: (string | Record) | null; readonly scripts?: Record; readonly id?: string; @@ -82885,6 +88921,7 @@ export type components = { readonly files?: readonly string[]; readonly bin?: Record; readonly man?: Record; + /** @nullable */ readonly directories?: (string | Record) | null; readonly os?: readonly string[]; readonly cpu?: readonly string[]; @@ -82895,7 +88932,9 @@ export type components = { readonly published_via_actions?: boolean; readonly deleted_by_id?: number; } | null; + /** @nullable */ readonly nuget_metadata?: readonly { + /** @nullable */ readonly id?: (string | Record | number) | null; readonly name?: string; readonly value?: boolean | string | number | { @@ -82910,11 +88949,15 @@ export type components = { readonly created_at: string; readonly download_url: string; readonly id: number; + /** @nullable */ readonly md5: string | null; readonly name: string; + /** @nullable */ readonly sha1: string | null; + /** @nullable */ readonly sha256: string | null; readonly size: number; + /** @nullable */ readonly state: string | null; readonly updated_at: string; }[]; @@ -82946,6 +88989,7 @@ export type components = { readonly draft?: boolean; readonly html_url?: string; readonly id?: number; + /** @nullable */ readonly name?: string | null; readonly prerelease?: boolean; readonly published_at?: string; @@ -82961,6 +89005,7 @@ export type components = { readonly updated_at?: string; readonly version: string; } | null; + /** @nullable */ readonly registry: { readonly about_url?: string; readonly name?: string; @@ -82968,6 +89013,7 @@ export type components = { readonly url?: string; readonly vendor?: string; } | null; + /** @nullable */ readonly updated_at: string | null; }; readonly repository?: components["schemas"]["repository-webhooks"]; @@ -82981,6 +89027,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly registry_package: { readonly created_at: string; + /** @nullable */ readonly description: unknown; readonly ecosystem: string; readonly html_url: string; @@ -83052,8 +89099,10 @@ export type components = { readonly created_at?: string; readonly download_url?: string; readonly id?: number; + /** @nullable */ readonly md5?: string | null; readonly name?: string; + /** @nullable */ readonly sha1?: string | null; readonly sha256?: string; readonly size?: number; @@ -83103,6 +89152,7 @@ export type components = { readonly updated_at: string; readonly version: string; }; + /** @nullable */ readonly registry: Record | null; readonly updated_at: string; }; @@ -83169,13 +89219,14 @@ export type components = { */ readonly release: { readonly assets: readonly ({ - /** Format: uri */ + /** @format uri */ readonly browser_download_url: string; readonly content_type: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly download_count: number; readonly id: number; + /** @nullable */ readonly label: string | null; /** @description The file name of the asset. */ readonly name: string; @@ -83186,98 +89237,111 @@ export type components = { * @enum {string} */ readonly state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly uploader?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ readonly assets_url: string; - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: uri */ + /** @format uri */ readonly discussion_url?: string; /** @description Whether the release is a draft or published */ readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly node_id: string; /** @@ -83285,7 +89349,10 @@ export type components = { * @enum {boolean} */ readonly prerelease: true; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly published_at: string | null; /** Reactions */ readonly reactions?: { @@ -83298,20 +89365,26 @@ export type components = { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @description The name of the tag. */ readonly tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ readonly target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ readonly upload_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly zipball_url: string | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -83407,7 +89480,10 @@ export type components = { /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ readonly action: string; readonly branch: string; - /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + /** + * @nullable + * @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + */ readonly client_payload: { readonly [key: string]: unknown; } | null; @@ -83426,12 +89502,15 @@ export type components = { readonly from: string; }; readonly description?: { + /** @nullable */ readonly from: string | null; }; readonly homepage?: { + /** @nullable */ readonly from: string | null; }; readonly topics?: { + /** @nullable */ readonly from?: readonly string[] | null; }; }; @@ -83577,65 +89656,70 @@ export type components = { readonly from: { /** Organization */ readonly organization?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issues_url: string; readonly login: string; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly public_members_url: string; - /** Format: uri */ + /** @format uri */ readonly repos_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** User */ + /** + * User + * @nullable + */ readonly user?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -83681,52 +89765,60 @@ export type components = { readonly affected_package_name: string; readonly affected_range: string; readonly created_at: string; + /** @nullable */ readonly dismiss_comment?: string | null; readonly dismiss_reason: string; readonly dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ readonly dismisser: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_reference: string | null; readonly fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ readonly fixed_at?: string; readonly fixed_in?: string; readonly ghsa_id: string; @@ -83768,48 +89860,55 @@ export type components = { readonly created_at: string; readonly dismiss_reason?: string; readonly dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ readonly dismisser?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_reference: string | null; readonly fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ readonly fixed_at?: string; readonly fixed_in?: string; readonly ghsa_id: string; @@ -83912,20 +90011,27 @@ export type components = { */ readonly source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly started_at: string; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly completed_at: string; - /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + /** + * @nullable + * @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates + */ readonly secret_types?: readonly string[] | null; - /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + /** + * @nullable + * @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated + */ readonly custom_pattern_name?: string | null; /** + * @nullable * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated * @enum {string|null} */ @@ -83970,6 +90076,7 @@ export type components = { readonly security_advisory: { readonly cvss: { readonly score: number; + /** @nullable */ readonly vector_string: string | null; }; readonly cvss_severities?: components["schemas"]["cvss-severities"]; @@ -83985,13 +90092,14 @@ export type components = { }[]; readonly published_at: string; readonly references: readonly { - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly severity: string; readonly summary: string; readonly updated_at: string; readonly vulnerabilities: readonly { + /** @nullable */ readonly first_patched_version: { readonly identifier: string; } | null; @@ -84104,7 +90212,10 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ readonly starred_at: string | null; }; /** star deleted event */ @@ -84116,68 +90227,85 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ readonly starred_at: unknown; }; /** status event */ readonly "webhook-status": { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly avatar_url?: string | null; /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */ readonly branches: readonly { readonly commit: { + /** @nullable */ readonly sha: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; }; readonly name: string; readonly protected: boolean; }[]; readonly commit: { - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id?: number; readonly login?: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commit: { readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -84189,9 +90317,12 @@ export type components = { }; readonly comment_count: number; readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -84204,74 +90335,84 @@ export type components = { readonly message: string; readonly tree: { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly verification: { + /** @nullable */ readonly payload: string | null; /** @enum {string} */ readonly reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; + /** @nullable */ readonly signature: string | null; readonly verified: boolean; + /** @nullable */ readonly verified_at?: string | null; }; }; - /** User */ + /** + * User + * @nullable + */ readonly committer: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id?: number; readonly login?: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly node_id: string; readonly parents: readonly { - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly context: string; readonly created_at: string; - /** @description The optional human-readable description added to the status. */ + /** + * @nullable + * @description The optional human-readable description added to the status. + */ readonly description: string | null; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ @@ -84288,7 +90429,10 @@ export type components = { * @enum {string} */ readonly state: "pending" | "success" | "failure" | "error"; - /** @description The optional link added to the status. */ + /** + * @nullable + * @description The optional link added to the status. + */ readonly target_url: string | null; readonly updated_at: string; }; @@ -84400,32 +90544,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84439,28 +90583,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -84483,89 +90628,104 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -84579,36 +90739,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -84653,32 +90815,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84692,28 +90854,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -84736,89 +90899,104 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -84832,36 +91010,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -84906,32 +91086,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84945,28 +91125,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -84989,89 +91170,104 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -85085,36 +91281,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -85190,32 +91388,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85229,28 +91427,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -85273,89 +91472,104 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -85369,36 +91583,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -85443,32 +91659,32 @@ export type components = { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85482,28 +91698,29 @@ export type components = { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -85526,89 +91743,104 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -85622,36 +91854,38 @@ export type components = { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -85674,6 +91908,7 @@ export type components = { /** workflow_dispatch event */ readonly "webhook-workflow-dispatch": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @nullable */ readonly inputs: { readonly [key: string]: unknown; } | null; @@ -85694,15 +91929,19 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { - /** Format: uri */ + /** @format uri */ readonly check_run_url: string; + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ readonly created_at: string; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85711,15 +91950,27 @@ export type components = { readonly node_id: string; readonly run_attempt: number; readonly run_id: number; - /** Format: uri */ + /** @format uri */ readonly run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_name: string | null; readonly started_at: string; /** @@ -85727,21 +91978,32 @@ export type components = { * @enum {string} */ readonly status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name: string | null; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "in_progress" | "completed" | "queued"; }[]; - /** Format: uri */ + /** @format uri */ readonly url: string; } & { readonly check_run_url?: string; @@ -85759,15 +92021,25 @@ export type components = { readonly run_attempt?: number; readonly run_id?: number; readonly run_url?: string; + /** @nullable */ readonly runner_group_id?: number | null; + /** @nullable */ readonly runner_group_name?: string | null; + /** @nullable */ readonly runner_id?: number | null; + /** @nullable */ readonly runner_name?: string | null; readonly started_at?: string; readonly status?: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name?: string | null; readonly steps?: readonly (Record | null)[]; readonly url?: string; @@ -85784,15 +92056,19 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { - /** Format: uri */ + /** @format uri */ readonly check_run_url: string; + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | null | "cancelled" | "neutral"; /** @description The time that the job created. */ readonly created_at: string; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85801,15 +92077,27 @@ export type components = { readonly node_id: string; readonly run_attempt: number; readonly run_id: number; - /** Format: uri */ + /** @format uri */ readonly run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_name: string | null; readonly started_at: string; /** @@ -85817,25 +92105,38 @@ export type components = { * @enum {string} */ readonly status: "queued" | "in_progress" | "completed"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name: string | null; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "failure" | "skipped" | "success" | null | "cancelled"; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "in_progress" | "completed" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ readonly url: string; } & { readonly check_run_url?: string; + /** @nullable */ readonly completed_at?: string | null; + /** @nullable */ readonly conclusion?: string | null; /** @description The time that the job created. */ readonly created_at?: string; @@ -85848,22 +92149,35 @@ export type components = { readonly run_attempt?: number; readonly run_id?: number; readonly run_url?: string; + /** @nullable */ readonly runner_group_id?: number | null; + /** @nullable */ readonly runner_group_name?: string | null; + /** @nullable */ readonly runner_id?: number | null; + /** @nullable */ readonly runner_name?: string | null; readonly started_at?: string; /** @enum {string} */ readonly status: "in_progress" | "completed" | "queued"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name?: string | null; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; + /** @nullable */ readonly conclusion: string | null; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "in_progress" | "completed" | "pending" | "queued"; @@ -85882,14 +92196,16 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { - /** Format: uri */ + /** @format uri */ readonly check_run_url: string; + /** @nullable */ readonly completed_at: string | null; + /** @nullable */ readonly conclusion: string | null; /** @description The time that the job created. */ readonly created_at: string; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly labels: readonly string[]; @@ -85897,31 +92213,46 @@ export type components = { readonly node_id: string; readonly run_attempt: number; readonly run_id: number; - /** Format: uri */ + /** @format uri */ readonly run_url: string; + /** @nullable */ readonly runner_group_id: number | null; + /** @nullable */ readonly runner_group_name: string | null; + /** @nullable */ readonly runner_id: number | null; + /** @nullable */ readonly runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ readonly started_at: string; /** @enum {string} */ readonly status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name: string | null; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "completed" | "in_progress" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly deployment?: components["schemas"]["deployment"]; @@ -85936,14 +92267,16 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { - /** Format: uri */ + /** @format uri */ readonly check_run_url: string; + /** @nullable */ readonly completed_at: string | null; + /** @nullable */ readonly conclusion: string | null; /** @description The time that the job created. */ readonly created_at: string; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly labels: readonly string[]; @@ -85951,31 +92284,46 @@ export type components = { readonly node_id: string; readonly run_attempt: number; readonly run_id: number; - /** Format: uri */ + /** @format uri */ readonly run_url: string; + /** @nullable */ readonly runner_group_id: number | null; + /** @nullable */ readonly runner_group_name: string | null; + /** @nullable */ readonly runner_id: number | null; + /** @nullable */ readonly runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ readonly started_at: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name: string | null; /** @enum {string} */ readonly status: "queued" | "in_progress" | "completed" | "waiting"; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; }[]; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly deployment?: components["schemas"]["deployment"]; @@ -85992,57 +92340,65 @@ export type components = { readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly artifacts_url: string; - /** Format: uri */ + /** @format uri */ readonly cancel_url: string; readonly check_suite_id: number; readonly check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ readonly check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; + /** @nullable */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -86051,9 +92407,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86064,9 +92423,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86079,143 +92441,152 @@ export type components = { }; /** Repository Lite */ readonly head_repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly jobs_url: string; - /** Format: uri */ + /** @format uri */ readonly logs_url: string; + /** @nullable */ readonly name: string | null; readonly node_id: string; readonly path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly previous_attempt_url: string | null; readonly pull_requests: readonly ({ readonly base: { @@ -86224,7 +92595,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -86235,16 +92606,17 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null)[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -86252,183 +92624,192 @@ export type components = { }[] | null; /** Repository Lite */ readonly repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly rerun_url: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; - /** Format: uri */ + /** @format uri */ readonly workflow_url: string; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. @@ -86449,56 +92830,64 @@ export type components = { readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly artifacts_url: string; - /** Format: uri */ + /** @format uri */ readonly cancel_url: string; readonly check_suite_id: number; readonly check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ readonly check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; + /** @nullable */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -86507,9 +92896,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86520,9 +92912,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86535,142 +92930,154 @@ export type components = { }; /** Repository Lite */ readonly head_repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** @description The name of the repository. */ + /** + * @nullable + * @description The name of the repository. + */ readonly name: string | null; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly jobs_url: string; - /** Format: uri */ + /** @format uri */ readonly logs_url: string; + /** @nullable */ readonly name: string | null; readonly node_id: string; readonly path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly previous_attempt_url: string | null; readonly pull_requests: readonly ({ readonly base: { @@ -86679,7 +93086,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -86690,16 +93097,17 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null)[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -86707,181 +93115,190 @@ export type components = { }[] | null; /** Repository Lite */ readonly repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly rerun_url: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; - /** Format: uri */ + /** @format uri */ readonly workflow_url: string; }; }; @@ -86897,57 +93314,65 @@ export type components = { readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly artifacts_url: string; - /** Format: uri */ + /** @format uri */ readonly cancel_url: string; readonly check_suite_id: number; readonly check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ readonly check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; + /** @nullable */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -86956,9 +93381,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86969,9 +93397,12 @@ export type components = { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86984,143 +93415,152 @@ export type components = { }; /** Repository Lite */ readonly head_repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly jobs_url: string; - /** Format: uri */ + /** @format uri */ readonly logs_url: string; + /** @nullable */ readonly name: string | null; readonly node_id: string; readonly path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly previous_attempt_url: string | null; readonly pull_requests: readonly { readonly base: { @@ -87129,7 +93569,7 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -87140,16 +93580,17 @@ export type components = { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -87157,183 +93598,192 @@ export type components = { }[] | null; /** Repository Lite */ readonly repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly rerun_url: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; - /** Format: uri */ + /** @format uri */ readonly workflow_url: string; readonly display_title: string; }; @@ -87450,6 +93900,7 @@ export type components = { readonly block?: { readonly reason?: string; readonly created_at?: string; + /** @nullable */ readonly html_url?: string | null; }; readonly message?: string; @@ -88237,6 +94688,7 @@ export interface operations { readonly "application/json": components["schemas"]["integration"] & ({ readonly client_id: string; readonly client_secret: string; + /** @nullable */ readonly webhook_secret: string | null; readonly pem: string; } & { @@ -89824,7 +96276,10 @@ export interface operations { readonly [key: string]: { /** @description The new content of the file. */ readonly content?: string; - /** @description The new filename for the file. */ + /** + * @nullable + * @description The new filename for the file. + */ readonly filename?: string | null; } | null; }; @@ -90760,8 +97215,8 @@ export interface operations { readonly content: { readonly "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ readonly last_read_at?: string; /** @description Whether the notification has been read. */ @@ -91359,7 +97814,10 @@ export interface operations { * @enum {string} */ readonly source?: "github" | "partner" | "custom"; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ readonly version?: string | null; }; /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ @@ -91586,7 +98044,10 @@ export interface operations { readonly maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ readonly enable_static_ip?: boolean; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ readonly image_version?: string | null; }; }; @@ -92076,7 +98537,10 @@ export interface operations { readonly restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ readonly selected_workflows?: readonly string[]; - /** @description The identifier of a hosted compute network configuration. */ + /** + * @nullable + * @description The identifier of a hosted compute network configuration. + */ readonly network_configuration_id?: string | null; }; }; @@ -92742,7 +99206,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -94183,7 +100650,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -94877,7 +101347,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -97426,7 +103899,10 @@ export interface operations { * @enum {string} */ readonly action: "approve" | "deny"; - /** @description Reason for approving or denying the requests. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the requests. Max 1024 characters. + */ readonly reason?: string | null; }; }; @@ -97459,7 +103935,10 @@ export interface operations { * @enum {string} */ readonly action: "approve" | "deny"; - /** @description Reason for approving or denying the request. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the request. Max 1024 characters. + */ readonly reason?: string | null; }; }; @@ -97701,9 +104180,15 @@ export interface operations { * @enum {string} */ readonly registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ readonly username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ readonly key_id: string; @@ -97838,9 +104323,15 @@ export interface operations { * @enum {string} */ readonly registry_type?: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ readonly username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -99362,7 +105853,10 @@ export interface operations { * @enum {string} */ readonly permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ readonly parent_team_id?: number | null; }; }; @@ -100547,6 +107041,7 @@ export interface operations { readonly content: { readonly "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100592,6 +107087,7 @@ export interface operations { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom + * @pattern ^(?:top|bottom|after:\d+)$ */ readonly position: string; /** @@ -100787,6 +107283,7 @@ export interface operations { readonly content: { readonly "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100862,6 +107359,7 @@ export interface operations { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last + * @pattern ^(?:first|last|after:\d+)$ */ readonly position: string; }; @@ -100966,6 +107464,7 @@ export interface operations { */ readonly name?: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -101347,6 +107846,7 @@ export interface operations { */ readonly visibility?: "public" | "private"; /** + * @nullable * @description Specify which security and analysis features to enable or disable for the repository. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -103265,7 +109765,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -104224,7 +110727,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Require status checks to pass before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require status checks to pass before merging. Set to `null` to disable. + */ readonly required_status_checks: { /** @description Require branches to be up to date before merging. */ readonly strict: boolean; @@ -104241,9 +110747,15 @@ export interface operations { readonly app_id?: number; }[]; } | null; - /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ + /** + * @nullable + * @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ readonly enforce_admins: boolean | null; - /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ readonly required_pull_request_reviews: { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ readonly dismissal_restrictions?: { @@ -104275,7 +110787,10 @@ export interface operations { readonly apps?: readonly string[]; }; } | null; - /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ + /** + * @nullable + * @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ readonly restrictions: { /** @description The list of user `login`s with push access */ readonly users: readonly string[]; @@ -104286,7 +110801,10 @@ export interface operations { } | null; /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ readonly required_linear_history?: boolean; - /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + /** + * @nullable + * @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ readonly allow_force_pushes?: boolean | null; /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ readonly allow_deletions?: boolean; @@ -105382,8 +111900,8 @@ export interface operations { */ readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** - * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly started_at?: string; /** @@ -105393,8 +111911,8 @@ export interface operations { */ readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -105524,8 +112042,8 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ readonly external_id?: string; /** - * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly started_at?: string; /** @@ -105540,8 +112058,8 @@ export interface operations { */ readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -106560,15 +113078,15 @@ export interface operations { readonly ref: components["schemas"]["code-scanning-ref-full"]; readonly sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** - * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ + * @format uri */ readonly checkout_uri?: string; /** - * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ @@ -106927,6 +113445,7 @@ export interface operations { readonly billable_owner?: components["schemas"]["simple-user"]; readonly defaults?: { readonly location: string; + /** @nullable */ readonly devcontainer_path: string | null; }; }; @@ -107075,7 +113594,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -108470,7 +114992,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -108697,6 +115222,7 @@ export interface operations { */ readonly environment?: string; /** + * @nullable * @description Short description of the deployment. * @default */ @@ -109046,7 +115572,10 @@ export interface operations { readonly "application/json": { readonly wait_timer?: components["schemas"]["wait-timer"]; readonly prevent_self_review?: components["schemas"]["prevent-self-review"]; - /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ + /** + * @nullable + * @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + */ readonly reviewers?: readonly { readonly type?: components["schemas"]["deployment-reviewer-type"]; /** @@ -109552,7 +116081,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id: string; @@ -109982,8 +116514,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ readonly email: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly date?: string; }; @@ -109994,8 +116526,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ readonly email?: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly date?: string; }; @@ -110259,8 +116791,8 @@ export interface operations { /** @description The email of the author of the tag */ readonly email: string; /** - * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly date?: string; }; @@ -110341,6 +116873,7 @@ export interface operations { */ readonly type?: "blob" | "tree" | "commit"; /** + * @nullable * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. @@ -111364,14 +117897,20 @@ export interface operations { readonly title: string | number; /** @description The contents of the issue. */ readonly body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ + /** + * @nullable + * @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ + */ readonly assignee?: string | null; + /** @nullable */ readonly milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ readonly labels?: readonly (string | { readonly id?: number; readonly name?: string; + /** @nullable */ readonly description?: string | null; + /** @nullable */ readonly color?: string | null; })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ @@ -111745,11 +118284,20 @@ export interface operations { readonly requestBody?: { readonly content: { readonly "application/json": { - /** @description The title of the issue. */ + /** + * @nullable + * @description The title of the issue. + */ readonly title?: (string | number) | null; - /** @description The contents of the issue. */ + /** + * @nullable + * @description The contents of the issue. + */ readonly body?: string | null; - /** @description Username to assign to this issue. **This field is closing down.** */ + /** + * @nullable + * @description Username to assign to this issue. **This field is closing down.** + */ readonly assignee?: string | null; /** * @description The open or closed state of the issue. @@ -111757,17 +118305,21 @@ export interface operations { */ readonly state?: "open" | "closed"; /** + * @nullable * @description The reason for the state change. Ignored unless `state` is changed. * @example not_planned * @enum {string|null} */ readonly state_reason?: "completed" | "not_planned" | "reopened" | null; + /** @nullable */ readonly milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ readonly labels?: readonly (string | { readonly id?: number; readonly name?: string; + /** @nullable */ readonly description?: string | null; + /** @nullable */ readonly color?: string | null; })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ @@ -113073,8 +119625,8 @@ export interface operations { /** @description A description of the milestone. */ readonly description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly due_on?: string; }; @@ -113178,8 +119730,8 @@ export interface operations { /** @description A description of the milestone. */ readonly description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly due_on?: string; }; @@ -113285,8 +119837,8 @@ export interface operations { readonly content: { readonly "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ readonly last_read_at?: string; }; @@ -113355,7 +119907,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ + /** + * @nullable + * @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." + */ readonly cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ readonly https_enforced?: boolean; @@ -113981,9 +120536,9 @@ export interface operations { /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ readonly head: string; /** - * Format: repo.nwo * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. * @example octo-org/octo-repo + * @format repo.nwo */ readonly head_repo?: string; /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ @@ -113995,9 +120550,9 @@ export interface operations { /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ readonly draft?: boolean; /** - * Format: int64 * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. * @example 1 + * @format int64 */ readonly issue?: number; }; @@ -116844,12 +123399,16 @@ export interface operations { */ readonly state: "error" | "failure" | "pending" | "success"; /** + * @nullable * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ readonly target_url?: string | null; - /** @description A short description of the status. */ + /** + * @nullable + * @description A short description of the status. + */ readonly description?: string | null; /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. @@ -117915,7 +124474,10 @@ export interface operations { * @enum {string} */ readonly permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ readonly parent_team_id?: number | null; }; }; @@ -118999,6 +125561,7 @@ export interface operations { */ readonly blog?: string; /** + * @nullable * @description The new Twitter username of the user. * @example therealomarj */ @@ -119358,7 +125921,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id: string; @@ -120489,7 +127055,10 @@ export interface operations { * @example Personal MacBook Air */ readonly title?: string; - /** @description The public SSH key to add to your GitHub account. */ + /** + * @description The public SSH key to add to your GitHub account. + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) + */ readonly key: string; }; }; @@ -121228,6 +127797,7 @@ export interface operations { */ readonly name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -121720,7 +128290,10 @@ export interface operations { * @example Personal MacBook Air */ readonly title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** + * @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com + */ readonly key: string; }; }; diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts index 2c9ec9141..136a570b6 100644 --- a/packages/openapi-typescript/examples/github-api-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-immutable.ts @@ -18417,74 +18417,74 @@ export type webhooks = Record; export interface components { schemas: { readonly root: { - /** Format: uri-template */ + /** @format uri-template */ readonly current_user_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly current_user_authorizations_html_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly authorizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly code_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commit_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly emails_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly emojis_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly feeds_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly followers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url: string; /** - * Format: uri-template * @deprecated + * @format uri-template */ readonly hub_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly label_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly organization_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly organization_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly organization_teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly public_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly rate_limit_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly repository_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly repository_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly current_user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly topic_search_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly user_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly user_organizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly user_search_url: string; }; /** @@ -18494,34 +18494,67 @@ export interface components { readonly "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ readonly vulnerability: { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range: string | null; - /** @description The package version that resolves the vulnerability. */ + /** + * @nullable + * @description The package version that resolves the vulnerability. + */ readonly first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ + /** + * @nullable + * @description The functions in the package that are affected by the vulnerability. + */ readonly vulnerable_functions: readonly string[] | null; }; + /** @nullable */ readonly "cvss-severities": { + /** @nullable */ readonly cvss_v3?: { - /** @description The CVSS 3 vector string. */ + /** + * @nullable + * @description The CVSS 3 vector string. + */ readonly vector_string: string | null; - /** @description The CVSS 3 score. */ + /** + * @nullable + * @description The CVSS 3 score. + */ readonly score: number | null; } | null; + /** @nullable */ readonly cvss_v4?: { - /** @description The CVSS 4 vector string. */ + /** + * @nullable + * @description The CVSS 4 vector string. + */ readonly vector_string: string | null; - /** @description The CVSS 4 score. */ + /** + * @nullable + * @description The CVSS 4 score. + */ readonly score: number | null; } | null; } | null; - /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + /** + * @nullable + * @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). + */ readonly "security-advisory-epss": { readonly percentage?: number; readonly percentile?: number; @@ -18531,37 +18564,42 @@ export interface components { * @description A GitHub user. */ readonly "simple-user": { + /** @nullable */ readonly name?: string | null; + /** @nullable */ readonly email?: string | null; /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -18571,25 +18609,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -18609,23 +18647,30 @@ export interface components { readonly "global-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id: string | null; /** @description The API URL for the advisory. */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The API URL for the repository advisory. + * @format uri */ readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ readonly summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ readonly description: string | null; /** * @description The type of advisory. @@ -18638,10 +18683,12 @@ export interface components { */ readonly severity: "critical" | "high" | "medium" | "low" | "unknown"; /** - * Format: uri + * @nullable * @description The URL of the advisory's source code. + * @format uri */ readonly source_code_location: string | null; + /** @nullable */ readonly identifiers: readonly { /** * @description The type of identifier. @@ -18651,50 +18698,68 @@ export interface components { /** @description The identifier value. */ readonly value: string; }[] | null; + /** @nullable */ readonly references: readonly string[] | null; /** - * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + * @format date-time */ readonly github_reviewed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. * This field is only populated when the advisory is imported from the National Vulnerability Database. + * @format date-time */ readonly nvd_published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; - /** @description The products and respective version ranges affected by the advisory. */ + /** + * @nullable + * @description The products and respective version ranges affected by the advisory. + */ readonly vulnerabilities: readonly components["schemas"]["vulnerability"][] | null; + /** @nullable */ readonly cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ readonly vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; readonly cvss_severities?: components["schemas"]["cvss-severities"]; readonly epss?: components["schemas"]["security-advisory-epss"]; + /** @nullable */ readonly cwes: readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ readonly cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description The users who contributed to the advisory. */ + /** + * @nullable + * @description The users who contributed to the advisory. + */ readonly credits: readonly { readonly user: components["schemas"]["simple-user"]; readonly type: components["schemas"]["security-advisory-credit-types"]; @@ -18724,16 +18789,20 @@ export interface components { * @description An enterprise on GitHub. */ readonly enterprise: { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ readonly description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ readonly website_url?: string | null; /** @@ -18754,20 +18823,23 @@ export interface components { */ readonly slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; }; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly integration: { @@ -18791,26 +18863,29 @@ export interface components { * @example Probot Owners */ readonly name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ readonly description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ readonly external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ readonly html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ readonly updated_at: string; /** @@ -18844,15 +18919,18 @@ export interface components { readonly installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ readonly client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ readonly webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ readonly pem?: string; } | null; /** - * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook + * @format uri */ readonly "webhook-config-url": string; /** @@ -18892,9 +18970,9 @@ export interface components { */ readonly guid: string; /** - * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z + * @format date-time */ readonly delivered_at: string; /** @@ -18923,24 +19001,28 @@ export interface components { */ readonly event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ readonly action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ readonly installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ readonly repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ readonly throttled_at?: string | null; }; @@ -18949,10 +19031,14 @@ export interface components { * @description Scim Error */ readonly "scim-error": { + /** @nullable */ readonly message?: string | null; + /** @nullable */ readonly documentation_url?: string | null; + /** @nullable */ readonly detail?: string | null; readonly status?: number; + /** @nullable */ readonly scimType?: string | null; readonly schemas?: readonly string[]; }; @@ -18988,9 +19074,9 @@ export interface components { */ readonly guid: string; /** - * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z + * @format date-time */ readonly delivered_at: string; /** @@ -19019,24 +19105,28 @@ export interface components { */ readonly event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ readonly action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ readonly installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ readonly repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ readonly throttled_at?: string | null; /** @@ -19045,21 +19135,33 @@ export interface components { */ readonly url?: string; readonly request: { - /** @description The request headers sent with the webhook delivery. */ + /** + * @nullable + * @description The request headers sent with the webhook delivery. + */ readonly headers: { readonly [key: string]: unknown; } | null; - /** @description The webhook payload. */ + /** + * @nullable + * @description The webhook payload. + */ readonly payload: { readonly [key: string]: unknown; } | null; }; readonly response: { - /** @description The response headers received when the delivery was made. */ + /** + * @nullable + * @description The response headers received when the delivery was made. + */ readonly headers: { readonly [key: string]: unknown; } | null; - /** @description The response payload received. */ + /** + * @nullable + * @description The response payload received. + */ readonly payload: string | null; }; }; @@ -19078,8 +19180,8 @@ export interface components { readonly account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; readonly requester: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-07-08T16:18:44-04:00 + * @format date-time */ readonly created_at: string; }; @@ -19337,40 +19439,46 @@ export interface components { }; /** * Simple User + * @nullable * @description A GitHub user. */ readonly "nullable-simple-user": { + /** @nullable */ readonly name?: string | null; + /** @nullable */ readonly email?: string | null; /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -19380,25 +19488,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -19419,6 +19527,7 @@ export interface components { * @example 1 */ readonly id: number; + /** @nullable */ readonly account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -19426,18 +19535,18 @@ export interface components { */ readonly repository_selection: "all" | "selected"; /** - * Format: uri * @example https://api.github.com/app/installations/1/access_tokens + * @format uri */ readonly access_tokens_url: string; /** - * Format: uri * @example https://api.github.com/installation/repositories + * @format uri */ readonly repositories_url: string; /** - * Format: uri * @example https://github.com/organizations/github/settings/installations/1 + * @format uri */ readonly html_url: string; /** @example 1 */ @@ -19448,11 +19557,14 @@ export interface components { readonly target_type: string; readonly permissions: components["schemas"]["app-permissions"]; readonly events: readonly string[]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ readonly single_file_name: string | null; /** @example true */ readonly has_multiple_single_files?: boolean; @@ -19466,13 +19578,20 @@ export interface components { /** @example github-actions */ readonly app_slug: string; readonly suspended_by: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly suspended_at: string | null; - /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ + /** + * @nullable + * @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" + */ readonly contact_email?: string | null; }; /** * License Simple + * @nullable * @description License Simple */ readonly "nullable-license-simple": { @@ -19481,15 +19600,19 @@ export interface components { /** @example MIT License */ readonly name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ readonly url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ readonly spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; } | null; /** @@ -19498,9 +19621,9 @@ export interface components { */ readonly repository: { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -19528,16 +19651,19 @@ export interface components { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -19559,28 +19685,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -19602,13 +19728,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -19622,30 +19748,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -19653,25 +19779,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -19743,18 +19872,21 @@ export interface components { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -19872,7 +20004,10 @@ export interface components { */ readonly single_file_paths?: readonly string[]; }; - /** Scoped Installation */ + /** + * Scoped Installation + * @nullable + */ readonly "nullable-scoped-installation": { readonly permissions: components["schemas"]["app-permissions"]; /** @@ -19880,7 +20015,10 @@ export interface components { * @enum {string} */ readonly repository_selection: "all" | "selected"; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ readonly single_file_name: string | null; /** @example true */ readonly has_multiple_single_files?: boolean; @@ -19892,8 +20030,8 @@ export interface components { */ readonly single_file_paths?: readonly string[]; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repositories_url: string; readonly account: components["schemas"]["simple-user"]; @@ -19903,32 +20041,45 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ readonly authorization: { - /** Format: int64 */ + /** @format int64 */ readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** @description A list of scopes that this authorization is in. */ + /** + * @nullable + * @description A list of scopes that this authorization is in. + */ readonly scopes: readonly string[] | null; readonly token: string; + /** @nullable */ readonly token_last_eight: string | null; + /** @nullable */ readonly hashed_token: string | null; readonly app: { readonly client_id: string; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; + /** @nullable */ readonly note: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly note_url: string | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; + /** @nullable */ readonly fingerprint: string | null; readonly user?: components["schemas"]["nullable-simple-user"]; readonly installation?: components["schemas"]["nullable-scoped-installation"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly expires_at: string | null; }; /** @@ -19947,9 +20098,9 @@ export interface components { */ readonly full_name: string; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; /** @@ -19977,11 +20128,14 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/github + * @format uri */ readonly html_url: string; - /** @example Github - Code thigns happen here */ + /** + * @nullable + * @example Github - Code thigns happen here + */ readonly name: string | null; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; @@ -20065,11 +20219,13 @@ export interface components { */ readonly feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ readonly max_teams: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20100,9 +20256,10 @@ export interface components { */ readonly language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly deadline: string | null; readonly starter_code_repository: components["schemas"]["simple-classroom-repository"]; @@ -20118,13 +20275,13 @@ export interface components { /** @example octocat */ readonly login: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; }; @@ -20206,11 +20363,13 @@ export interface components { */ readonly feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ readonly max_teams?: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20241,9 +20400,10 @@ export interface components { */ readonly language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly deadline: string | null; readonly classroom: components["schemas"]["simple-classroom"]; @@ -20320,8 +20480,8 @@ export interface components { /** @example Contributor Covenant */ readonly name: string; /** - * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant + * @format uri */ readonly url: string; /** @@ -20372,7 +20532,10 @@ export interface components { * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). */ readonly body?: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; }; /** @description A code security configuration */ @@ -20423,14 +20586,21 @@ export interface components { * @enum {string} */ readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ readonly code_scanning_default_setup_options?: { /** + * @nullable * @description Whether to use labeled runners or standard GitHub runners. * @enum {string|null} */ readonly runner_type?: "standard" | "labeled" | "not_set" | null; - /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning when runner_type is 'labeled'. + */ readonly runner_label?: string | null; } | null; /** @@ -20482,28 +20652,34 @@ export interface components { */ readonly enforcement?: "enforced" | "unenforced"; /** - * Format: uri * @description The URL of the configuration + * @format uri */ readonly url?: string; /** - * Format: uri * @description The URL of the configuration + * @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; }; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ readonly "code-scanning-default-setup-options": { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ readonly runner_type?: "standard" | "labeled" | "not_set"; - /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. + */ readonly runner_label?: string | null; } | null; /** @description A list of default code security configurations */ @@ -20521,9 +20697,9 @@ export interface components { */ readonly "simple-repository": { /** - * Format: int64 * @description A unique identifier of the repository. * @example 1296269 + * @format int64 */ readonly id: number; /** @@ -20545,12 +20721,13 @@ export interface components { /** @description Whether the repository is private. */ readonly private: boolean; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; /** + * @nullable * @description The repository description. * @example This your first repo! */ @@ -20558,9 +20735,9 @@ export interface components { /** @description Whether the repository is a fork. */ readonly fork: boolean; /** - * Format: uri * @description The URL to get more information about the repository from the GitHub API. * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @@ -20609,33 +20786,33 @@ export interface components { */ readonly contents_url: string; /** - * Format: uri * @description A template for the API URL to list the contributors to the repository. * @example https://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @description The API URL to list the deployments of the repository. * @example https://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @description The API URL to list the downloads on the repository. * @example https://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @description The API URL to list the events of the repository. * @example https://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @description The API URL to list the forks of the repository. * @example https://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @@ -20679,15 +20856,15 @@ export interface components { */ readonly labels_url: string; /** - * Format: uri * @description The API URL to get information about the languages of the repository. * @example https://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @description The API URL to merge branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @@ -20711,9 +20888,9 @@ export interface components { */ readonly releases_url: string; /** - * Format: uri * @description The API URL to list the stargazers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @@ -20722,27 +20899,27 @@ export interface components { */ readonly statuses_url: string; /** - * Format: uri * @description The API URL to list the subscribers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @description The API URL to subscribe to notifications for this repository. * @example https://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @description The API URL to get information about tags on the repository. * @example https://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @description The API URL to list the teams on the repository. * @example https://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @@ -20751,9 +20928,9 @@ export interface components { */ readonly trees_url: string; /** - * Format: uri * @description The API URL to list the hooks on the repository. * @example https://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; }; @@ -20785,7 +20962,10 @@ export interface components { readonly severity: "low" | "medium" | "high" | "critical"; /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ + /** + * @nullable + * @description Details pertaining to the package version that patches this vulnerability. + */ readonly first_patched_version: { /** @description The package version that patches this vulnerability. */ readonly identifier: string; @@ -20795,7 +20975,10 @@ export interface components { readonly "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ + /** + * @nullable + * @description The unique CVE ID assigned to the advisory. + */ readonly cve_id: string | null; /** @description A short, plain text summary of the advisory. */ readonly summary: string; @@ -20812,7 +20995,10 @@ export interface components { readonly cvss: { /** @description The overall CVSS score of the advisory. */ readonly score: number; - /** @description The full CVSS vector string for the advisory. */ + /** + * @nullable + * @description The full CVSS vector string for the advisory. + */ readonly vector_string: string | null; }; readonly cvss_severities?: components["schemas"]["cvss-severities"]; @@ -20837,60 +21023,64 @@ export interface components { /** @description Links to additional advisory information. */ readonly references: readonly { /** - * Format: uri * @description The URL of the reference. + * @format uri */ readonly url: string; }[]; /** - * Format: date-time * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly withdrawn_at: string | null; }; /** - * Format: uri * @description The REST API URL of the alert resource. + * @format uri */ readonly "alert-url": string; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly "alert-html-url": string; /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-created-at": string; /** - * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-updated-at": string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-dismissed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-fixed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ @@ -20907,6 +21097,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -20921,19 +21112,24 @@ export interface components { readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; readonly dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ readonly dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ readonly dismissed_comment: string | null; readonly fixed_at: components["schemas"]["alert-fixed-at"]; readonly auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; readonly repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time + * @nullable * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "nullable-alert-updated-at": string | null; /** @@ -20942,6 +21138,7 @@ export interface components { */ readonly "secret-scanning-alert-state": "open" | "resolved"; /** + * @nullable * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. * @enum {string|null} */ @@ -20953,15 +21150,16 @@ export interface components { readonly url?: components["schemas"]["alert-url"]; readonly html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ readonly locations_url?: string; readonly state?: components["schemas"]["secret-scanning-alert-state"]; readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly resolved_at?: string | null; readonly resolved_by?: components["schemas"]["nullable-simple-user"]; @@ -20975,34 +21173,54 @@ export interface components { /** @description The secret that was detected. */ readonly secret?: string; readonly repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ readonly push_protection_bypassed?: boolean | null; readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly push_protection_bypassed_at?: string | null; readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ readonly push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ readonly push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ readonly push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ + /** + * @nullable + * @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"; - /** @description Whether the secret was publicly leaked. */ + /** + * @nullable + * @description Whether the secret was publicly leaked. + */ readonly publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. + */ readonly multi_repo?: boolean | null; }; /** @@ -21013,30 +21231,32 @@ export interface components { readonly id: number; readonly login: string; readonly display_login?: string; + /** @nullable */ readonly gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; }; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly "nullable-milestone": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ readonly labels_url: string; /** @example 1002604 */ @@ -21060,7 +21280,10 @@ export interface components { * @example v1.0 */ readonly title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ readonly description: string | null; readonly creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -21068,28 +21291,31 @@ export interface components { /** @example 8 */ readonly closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ readonly due_on: string | null; } | null; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly "nullable-integration": { @@ -21113,26 +21339,29 @@ export interface components { * @example Probot Owners */ readonly name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ readonly description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ readonly external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ readonly html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ readonly updated_at: string; /** @@ -21166,7 +21395,10 @@ export interface components { readonly installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ readonly client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ readonly webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ readonly pem?: string; @@ -21180,7 +21412,7 @@ export interface components { readonly "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** Reaction Rollup */ readonly "reaction-rollup": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly total_count: number; readonly "+1": number; @@ -21203,23 +21435,23 @@ export interface components { * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ readonly issue: { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -21232,6 +21464,7 @@ export interface components { */ readonly state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -21243,6 +21476,7 @@ export interface components { */ readonly title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -21256,45 +21490,67 @@ export interface components { * ] */ readonly labels: readonly (string | { - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly name?: string; + /** @nullable */ readonly description?: string | null; + /** @nullable */ readonly color?: string | null; readonly default?: boolean; })[]; readonly assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; readonly milestone: components["schemas"]["nullable-milestone"]; readonly locked: boolean; + /** @nullable */ readonly active_lock_reason?: string | null; readonly comments: number; readonly pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly draft?: boolean; readonly closed_by?: components["schemas"]["nullable-simple-user"]; readonly body_html?: string; readonly body_text?: string; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; readonly repository?: components["schemas"]["repository"]; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21308,16 +21564,16 @@ export interface components { */ readonly "issue-comment": { /** - * Format: int64 * @description Unique identifier of the issue comment * @example 42 + * @format int64 */ readonly id: number; readonly node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ readonly url: string; /** @@ -21327,20 +21583,20 @@ export interface components { readonly body?: string; readonly body_text?: string; readonly body_html?: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly author_association: components["schemas"]["author-association"]; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21352,12 +21608,13 @@ export interface components { */ readonly event: { readonly id: string; + /** @nullable */ readonly type: string | null; readonly actor: components["schemas"]["actor"]; readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly org?: components["schemas"]["actor"]; @@ -21368,6 +21625,7 @@ export interface components { readonly pages?: readonly { readonly page_name?: string; readonly title?: string; + /** @nullable */ readonly summary?: string | null; readonly action?: string; readonly sha?: string; @@ -21375,7 +21633,10 @@ export interface components { }[]; }; readonly public: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; }; /** @@ -21439,19 +21700,19 @@ export interface components { * @description Base Gist */ readonly "base-gist": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly id: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly git_pull_url: string; - /** Format: uri */ + /** @format uri */ readonly git_push_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly files: { readonly [key: string]: { @@ -21468,15 +21729,16 @@ export interface components { }; }; readonly public: boolean; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; + /** @nullable */ readonly description: string | null; readonly comments: number; readonly comments_enabled?: boolean; readonly user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly owner?: components["schemas"]["simple-user"]; readonly truncated?: boolean; @@ -21489,7 +21751,7 @@ export interface components { */ readonly "public-user": { readonly login: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; /** * @description discriminator enum property added by openapi-typescript @@ -21497,47 +21759,61 @@ export interface components { */ readonly user_view_type: "public"; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; + /** @nullable */ readonly gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly followers_url: string; readonly following_url: string; readonly gists_url: string; readonly starred_url: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url: string; - /** Format: uri */ + /** @format uri */ readonly repos_url: string; readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url: string; readonly type: string; readonly site_admin: boolean; + /** @nullable */ readonly name: string | null; + /** @nullable */ readonly company: string | null; + /** @nullable */ readonly blog: string | null; + /** @nullable */ readonly location: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly notification_email?: string | null; + /** @nullable */ readonly hireable: boolean | null; + /** @nullable */ readonly bio: string | null; + /** @nullable */ readonly twitter_username?: string | null; readonly public_repos: number; readonly public_gists: number; readonly followers: number; readonly following: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly plan?: { readonly collaborators: number; @@ -21563,14 +21839,14 @@ export interface components { readonly "gist-history": { readonly user?: components["schemas"]["nullable-simple-user"]; readonly version?: string; - /** Format: date-time */ + /** @format date-time */ readonly committed_at?: string; readonly change_status?: { readonly total?: number; readonly additions?: number; readonly deletions?: number; }; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** @@ -21578,37 +21854,44 @@ export interface components { * @description Gist Simple */ readonly "gist-simple": { - /** @deprecated */ + /** + * @deprecated + * @nullable + */ readonly forks?: readonly { readonly id?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user?: components["schemas"]["public-user"]; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; }[] | null; - /** @deprecated */ + /** + * @deprecated + * @nullable + */ readonly history?: readonly components["schemas"]["gist-history"][] | null; /** * Gist + * @nullable * @description Gist */ readonly fork_of?: { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly id: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly git_pull_url: string; - /** Format: uri */ + /** @format uri */ readonly git_push_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly files: { readonly [key: string]: { @@ -21620,15 +21903,16 @@ export interface components { }; }; readonly public: boolean; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; + /** @nullable */ readonly description: string | null; readonly comments: number; readonly comments_enabled?: boolean; readonly user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly owner?: components["schemas"]["nullable-simple-user"]; readonly truncated?: boolean; @@ -21662,9 +21946,11 @@ export interface components { readonly public?: boolean; readonly created_at?: string; readonly updated_at?: string; + /** @nullable */ readonly description?: string | null; readonly comments?: number; readonly comments_enabled?: boolean; + /** @nullable */ readonly user?: string | null; readonly comments_url?: string; readonly owner?: components["schemas"]["simple-user"]; @@ -21680,8 +21966,8 @@ export interface components { /** @example MDExOkdpc3RDb21tZW50MQ== */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + * @format uri */ readonly url: string; /** @@ -21691,13 +21977,13 @@ export interface components { readonly body: string; readonly user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ readonly updated_at: string; readonly author_association: components["schemas"]["author-association"]; @@ -21708,8 +21994,8 @@ export interface components { */ readonly "gist-commit": { /** - * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + * @format uri */ readonly url: string; /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ @@ -21721,8 +22007,8 @@ export interface components { readonly deletions?: number; }; /** - * Format: date-time * @example 2010-04-14T02:15:15Z + * @format date-time */ readonly committed_at: string; }; @@ -21764,15 +22050,19 @@ export interface components { /** @example MIT License */ readonly name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ readonly url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ readonly spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; }; /** @@ -21784,18 +22074,22 @@ export interface components { readonly key: string; /** @example MIT License */ readonly name: string; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ readonly spdx_id: string | null; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ readonly url: string | null; /** @example MDc6TGljZW5zZW1pdA== */ readonly node_id: string; /** - * Format: uri * @example http://choosealicense.com/licenses/mit/ + * @format uri */ readonly html_url: string; /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ @@ -21857,13 +22151,13 @@ export interface components { */ readonly "marketplace-listing-plan": { /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts + * @format uri */ readonly accounts_url: string; /** @example 1313 */ @@ -21885,6 +22179,7 @@ export interface components { readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; /** @example true */ readonly has_free_trial: boolean; + /** @nullable */ readonly unit_name: string | null; /** @example published */ readonly state: string; @@ -21906,20 +22201,26 @@ export interface components { readonly id: number; readonly login: string; readonly organization_billing_email?: string; + /** @nullable */ readonly email?: string | null; + /** @nullable */ readonly marketplace_pending_change?: { readonly is_installed?: boolean; readonly effective_date?: string; + /** @nullable */ readonly unit_count?: number | null; readonly id?: number; readonly plan?: components["schemas"]["marketplace-listing-plan"]; } | null; readonly marketplace_purchase: { readonly billing_cycle?: string; + /** @nullable */ readonly next_billing_date?: string | null; readonly is_installed?: boolean; + /** @nullable */ readonly unit_count?: number | null; readonly on_free_trial?: boolean; + /** @nullable */ readonly free_trial_ends_on?: string | null; readonly updated_at?: string; readonly plan?: components["schemas"]["marketplace-listing-plan"]; @@ -22043,6 +22344,7 @@ export interface components { }; }; }; + /** @nullable */ readonly "security-and-analysis": { readonly advanced_security?: { /** @enum {string} */ @@ -22079,8 +22381,8 @@ export interface components { */ readonly "minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -22092,16 +22394,19 @@ export interface components { readonly owner: components["schemas"]["simple-user"]; readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -22123,28 +22428,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -22165,13 +22470,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -22184,43 +22489,46 @@ export interface components { readonly releases_url: string; readonly ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ readonly trees_url: string; readonly clone_url?: string; + /** @nullable */ readonly mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; readonly svn_url?: string; + /** @nullable */ readonly homepage?: string | null; + /** @nullable */ readonly language?: string | null; readonly forks_count?: number; readonly stargazers_count?: number; @@ -22241,18 +22549,21 @@ export interface components { readonly disabled?: boolean; readonly visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at?: string | null; readonly permissions?: { @@ -22269,6 +22580,7 @@ export interface components { readonly subscribers_count?: number; readonly network_count?: number; readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ readonly license?: { readonly key?: string; readonly name?: string; @@ -22303,6 +22615,7 @@ export interface components { readonly reason: string; readonly unread: boolean; readonly updated_at: string; + /** @nullable */ readonly last_read_at: string | null; readonly url: string; /** @example https://api.github.com/notifications/threads/2/subscription */ @@ -22316,25 +22629,27 @@ export interface components { /** @example true */ readonly subscribed: boolean; readonly ignored: boolean; + /** @nullable */ readonly reason: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-06T21:34:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: uri * @example https://api.github.com/notifications/threads/1/subscription + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/notifications/threads/1 + * @format uri */ readonly thread_url?: string; /** - * Format: uri * @example https://api.github.com/repos/1 + * @format uri */ readonly repository_url?: string; }; @@ -22350,18 +22665,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22374,7 +22689,10 @@ export interface components { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; }; readonly "billing-usage-report": { @@ -22415,18 +22733,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22439,25 +22757,31 @@ export interface components { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; /** @example github */ readonly name?: string; /** @example GitHub */ readonly company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ readonly blog?: string; /** @example San Francisco */ readonly location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ readonly email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ readonly twitter_username?: string | null; /** @example true */ readonly is_verified?: boolean; @@ -22474,8 +22798,8 @@ export interface components { /** @example 0 */ readonly following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** @example Organization */ @@ -22484,11 +22808,18 @@ export interface components { readonly total_private_repos?: number; /** @example 100 */ readonly owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ readonly private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ readonly disk_usage?: number | null; /** + * @nullable * @description The number of collaborators on private repositories. * * This field may be null if the number of private repositories is over 50,000. @@ -22496,8 +22827,9 @@ export interface components { */ readonly collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ readonly billing_email?: string | null; readonly plan?: { @@ -22507,10 +22839,17 @@ export interface components { readonly filled_seats?: number; readonly seats?: number; }; + /** @nullable */ readonly default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly two_factor_requirement_enabled?: boolean | null; /** @example all */ readonly members_allowed_repository_creation_type?: string; @@ -22526,7 +22865,10 @@ export interface components { readonly members_can_create_public_pages?: boolean; /** @example true */ readonly members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ readonly members_can_fork_private_repositories?: boolean | null; /** @example false */ readonly web_commit_signoff_required?: boolean; @@ -22596,18 +22938,22 @@ export interface components { */ readonly secret_scanning_push_protection_custom_link_enabled?: boolean; /** + * @nullable * @description An optional URL string to display to contributors who are blocked from pushing a secret. * @example https://github.com/test-org/test-repo/blob/main/README.md */ readonly secret_scanning_push_protection_custom_link?: string | null; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly archived_at: string | null; /** * @description Controls whether or not deploy keys may be added and used for repositories in the organization. @@ -22644,6 +22990,7 @@ export interface components { }; /** * GitHub-hosted runner image details. + * @nullable * @description Provides details of a hosted runner image */ readonly "nullable-actions-hosted-runner-pool-image": { @@ -22767,9 +23114,10 @@ export interface components { /** @description The public IP ranges when public IP is enabled for the hosted runners. */ readonly public_ips?: readonly components["schemas"]["public-ip"][]; /** - * Format: date-time + * @nullable * @description The time at which the runner was last used, in ISO 8601 format. * @example 2022-10-09T23:39:01Z + * @format date-time */ readonly last_active_on?: string | null; }; @@ -22981,9 +23329,9 @@ export interface components { */ readonly token: string; /** - * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z + * @format date-time */ readonly expires_at: string; /** @@ -22995,7 +23343,10 @@ export interface components { readonly permissions?: Record; /** @description The repositories this token has access to */ readonly repositories?: readonly components["schemas"]["repository"][]; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ readonly single_file?: string | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -23013,9 +23364,9 @@ export interface components { * @example SECRET_TOKEN */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** * @description Visibility of a secret @@ -23023,8 +23374,8 @@ export interface components { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories + * @format uri */ readonly selected_repositories_url?: string; }; @@ -23068,15 +23419,15 @@ export interface components { */ readonly value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly updated_at: string; /** @@ -23085,14 +23436,17 @@ export interface components { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/variables/USERNAME/repositories + * @format uri */ readonly selected_repositories_url?: string; }; /** @description The name of the tool used to generate the code scanning analysis. */ readonly "code-scanning-analysis-tool-name": string; - /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + /** + * @nullable + * @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. + */ readonly "code-scanning-analysis-tool-guid": string | null; /** * @description State of a code scanning alert. @@ -23105,33 +23459,43 @@ export interface components { */ readonly "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; /** - * Format: uri * @description The REST API URL for fetching the list of instances for an alert. + * @format uri */ readonly "alert-instances-url": string; /** + * @nullable * @description State of a code scanning alert. * @enum {string|null} */ readonly "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** + * @nullable * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ readonly "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; - /** @description The dismissal comment associated with the dismissal of the alert. */ + /** + * @nullable + * @description The dismissal comment associated with the dismissal of the alert. + */ readonly "code-scanning-alert-dismissed-comment": string | null; readonly "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ readonly id?: string | null; /** @description The name of the rule used to detect the alert. */ readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -23140,14 +23504,26 @@ export interface components { readonly description?: string; /** @description A description of the rule used to detect the alert. */ readonly full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ readonly tags?: readonly string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; }; - /** @description The version of the tool used to generate the code scanning analysis. */ + /** + * @nullable + * @description The version of the tool used to generate the code scanning analysis. + */ readonly "code-scanning-analysis-tool-version": string | null; readonly "code-scanning-analysis-tool": { readonly name?: components["schemas"]["code-scanning-analysis-tool-name"]; @@ -23174,6 +23550,7 @@ export interface components { readonly end_column?: number; }; /** + * @nullable * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ @@ -23216,6 +23593,7 @@ export interface components { }; /** * Codespace machine + * @nullable * @description A description of the machine powering a codespace. */ readonly "nullable-codespace-machine": { @@ -23250,6 +23628,7 @@ export interface components { */ readonly cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -23262,8 +23641,8 @@ export interface components { */ readonly codespace: { /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @@ -23272,11 +23651,13 @@ export interface components { */ readonly name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ readonly display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -23286,29 +23667,31 @@ export interface components { readonly repository: components["schemas"]["minimal-repository"]; readonly machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ readonly devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ readonly prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly last_used_at: string; /** @@ -23318,8 +23701,8 @@ export interface components { */ readonly state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ readonly url: string; /** @description Details about the codespace's git repository. */ @@ -23351,63 +23734,81 @@ export interface components { */ readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ readonly idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ readonly web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ readonly machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ readonly start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ readonly stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ readonly publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ readonly pulls_url: string | null; readonly recent_folders: readonly string[]; readonly runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ readonly allowed_port_privacy_settings?: readonly string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ readonly pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ readonly pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ readonly idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ readonly retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ readonly retention_expires_at?: string | null; /** + * @nullable * @description The text to display to a user when a codespace has been stopped for a potentially actionable reason. * @example you've used 100% of your spending limit for Codespaces */ @@ -23424,13 +23825,13 @@ export interface components { */ readonly name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly updated_at: string; /** @@ -23439,9 +23840,9 @@ export interface components { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories + * @format uri */ readonly selected_repositories_url?: string; }; @@ -23528,6 +23929,7 @@ export interface components { }; /** * Organization Simple + * @nullable * @description A GitHub organization. */ readonly "nullable-organization-simple": { @@ -23538,18 +23940,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -23562,11 +23964,15 @@ export interface components { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; } | null; /** * Team Simple + * @nullable * @description Groups of organization members that gives permissions on specified repositories. */ readonly "nullable-team-simple": { @@ -23578,9 +23984,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ readonly node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ readonly url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -23591,6 +23997,7 @@ export interface components { */ readonly name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -23611,13 +24018,13 @@ export interface components { */ readonly notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ readonly repositories_url: string; /** @example justice-league */ @@ -23637,6 +24044,7 @@ export interface components { readonly node_id: string; readonly name: string; readonly slug: string; + /** @nullable */ readonly description: string | null; readonly privacy?: string; readonly notification_setting?: string; @@ -23648,15 +24056,15 @@ export interface components { readonly maintain: boolean; readonly admin: boolean; }; - /** Format: uri */ + /** @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; readonly members_url: string; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly parent: components["schemas"]["nullable-team-simple"]; }; @@ -23665,27 +24073,33 @@ export interface components { * @description Group of enterprise owners and/or members */ readonly "enterprise-team": { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly name: string; readonly slug: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @example disabled | all */ readonly sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + /** + * @nullable + * @example 62ab9291-fae2-468e-974b-7e45096d5021 + */ readonly group_id?: string | null; - /** @example Justice League */ + /** + * @nullable + * @example Justice League + */ readonly group_name?: string | null; /** - * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league + * @format uri */ readonly html_url: string; readonly members_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -23695,29 +24109,37 @@ export interface components { readonly "copilot-seat-details": { readonly assignee: components["schemas"]["simple-user"]; readonly organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + /** + * @nullable + * @description The team through which the assignee is granted access to GitHub Copilot, if applicable. + */ readonly assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** - * Format: date + * @nullable * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @format date */ readonly pending_cancellation_date?: string | null; /** - * Format: date-time + * @nullable * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @format date-time */ readonly last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + /** + * @nullable + * @description Last editor that was used by the user for a GitHub Copilot completion. + */ readonly last_activity_editor?: string | null; /** - * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @deprecated * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at?: string; /** @@ -23726,7 +24148,10 @@ export interface components { */ readonly plan_type?: "business" | "enterprise" | "unknown"; }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot editor code completions in the IDE. + */ readonly "copilot-ide-code-completions": ({ /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ readonly total_engaged_users?: number; @@ -23748,7 +24173,10 @@ export interface components { readonly name?: string; /** @description Indicates whether a model is custom or default. */ readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ readonly custom_model_training_date?: string | null; /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ readonly total_engaged_users?: number; @@ -23774,7 +24202,10 @@ export interface components { } & { readonly [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in the IDE. + */ readonly "copilot-ide-chat": ({ /** @description Total number of users who prompted Copilot Chat in the IDE. */ readonly total_engaged_users?: number; @@ -23789,7 +24220,10 @@ export interface components { readonly name?: string; /** @description Indicates whether a model is custom or default. */ readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ readonly custom_model_training_date?: string | null; /** @description The number of users who prompted Copilot Chat in the given editor and model. */ readonly total_engaged_users?: number; @@ -23804,7 +24238,10 @@ export interface components { } & { readonly [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in github.com + */ readonly "copilot-dotcom-chat": ({ /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ readonly total_engaged_users?: number; @@ -23814,7 +24251,10 @@ export interface components { readonly name?: string; /** @description Indicates whether a model is custom or default. */ readonly is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ + /** + * @nullable + * @description The training date for the custom model (if applicable). + */ readonly custom_model_training_date?: string | null; /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ readonly total_engaged_users?: number; @@ -23824,7 +24264,10 @@ export interface components { } & { readonly [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot for pull requests. */ + /** + * @nullable + * @description Usage metrics for Copilot for pull requests. + */ readonly "copilot-dotcom-pull-requests": ({ /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ readonly total_engaged_users?: number; @@ -23840,7 +24283,10 @@ export interface components { readonly name?: string; /** @description Indicates whether a model is custom or default. */ readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ readonly custom_model_training_date?: string | null; /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ readonly total_pr_summaries_created?: number; @@ -23857,8 +24303,8 @@ export interface components { */ readonly "copilot-usage-metrics-day": { /** - * Format: date * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @format date */ readonly date: string; /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ @@ -23878,8 +24324,8 @@ export interface components { */ readonly "copilot-usage-metrics": { /** - * Format: date * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @format date */ readonly day: string; /** @description The total number of Copilot code completion suggestions shown to users. */ @@ -23898,7 +24344,10 @@ export interface components { readonly total_chat_turns?: number; /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ readonly total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ + /** + * @nullable + * @description Breakdown of Copilot code completions usage by language and editor + */ readonly breakdown: readonly ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ readonly language?: string; @@ -23928,9 +24377,9 @@ export interface components { * @example SECRET_TOKEN */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** * @description Visibility of a secret @@ -23938,8 +24387,8 @@ export interface components { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories + * @format uri */ readonly selected_repositories_url?: string; }; @@ -23961,12 +24410,13 @@ export interface components { }; /** * Minimal Repository + * @nullable * @description Minimal Repository */ readonly "nullable-minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -23978,16 +24428,19 @@ export interface components { readonly owner: components["schemas"]["simple-user"]; readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -24009,28 +24462,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -24051,13 +24504,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -24070,43 +24523,46 @@ export interface components { readonly releases_url: string; readonly ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ readonly trees_url: string; readonly clone_url?: string; + /** @nullable */ readonly mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; readonly svn_url?: string; + /** @nullable */ readonly homepage?: string | null; + /** @nullable */ readonly language?: string | null; readonly forks_count?: number; readonly stargazers_count?: number; @@ -24127,18 +24583,21 @@ export interface components { readonly disabled?: boolean; readonly visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at?: string | null; readonly permissions?: { @@ -24155,6 +24614,7 @@ export interface components { readonly subscribers_count?: number; readonly network_count?: number; readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ readonly license?: { readonly key?: string; readonly name?: string; @@ -24209,9 +24669,9 @@ export interface components { readonly visibility: "private" | "public"; readonly owner?: components["schemas"]["nullable-simple-user"]; readonly repository?: components["schemas"]["nullable-minimal-repository"]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -24219,13 +24679,17 @@ export interface components { * @description Organization Invitation */ readonly "organization-invitation": { - /** Format: int64 */ + /** @format int64 */ readonly id: number; + /** @nullable */ readonly login: string | null; + /** @nullable */ readonly email: string | null; readonly role: string; readonly created_at: string; + /** @nullable */ readonly failed_at?: string | null; + /** @nullable */ readonly failed_reason?: string | null; readonly inviter: components["schemas"]["simple-user"]; readonly team_count: number; @@ -24244,18 +24708,18 @@ export interface components { /** @example 1 */ readonly id: number; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings + * @format uri */ readonly ping_url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries + * @format uri */ readonly deliveries_url?: string; /** @example web */ @@ -24280,13 +24744,13 @@ export interface components { readonly secret?: string; }; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ readonly created_at: string; readonly type: string; @@ -24301,15 +24765,16 @@ export interface components { /** @description The API path's route template */ readonly api_route?: string; /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ readonly total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ readonly rate_limited_request_count?: number; + /** @nullable */ readonly last_rate_limited_timestamp?: string | null; readonly last_request_timestamp?: string; }[]; @@ -24320,10 +24785,11 @@ export interface components { readonly "api-insights-subject-stats": readonly { readonly subject_type?: string; readonly subject_name?: string; - /** Format: int64 */ + /** @format int64 */ readonly subject_id?: number; readonly total_request_count?: number; readonly rate_limited_request_count?: number; + /** @nullable */ readonly last_rate_limited_timestamp?: string | null; readonly last_request_timestamp?: string; }[]; @@ -24333,13 +24799,13 @@ export interface components { */ readonly "api-insights-summary-stats": { /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ readonly total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ readonly rate_limited_request_count?: number; }; @@ -24349,9 +24815,9 @@ export interface components { */ readonly "api-insights-time-stats": readonly { readonly timestamp?: string; - /** Format: int64 */ + /** @format int64 */ readonly total_request_count?: number; - /** Format: int64 */ + /** @format int64 */ readonly rate_limited_request_count?: number; }[]; /** @@ -24361,14 +24827,21 @@ export interface components { readonly "api-insights-user-stats": readonly { readonly actor_type?: string; readonly actor_name?: string; - /** Format: int64 */ + /** @format int64 */ readonly actor_id?: number; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ readonly integration_id?: number | null; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ readonly oauth_application_id?: number | null; readonly total_request_count?: number; readonly rate_limited_request_count?: number; + /** @nullable */ readonly last_rate_limited_timestamp?: string | null; readonly last_request_timestamp?: string; }[]; @@ -24387,8 +24860,8 @@ export interface components { /** @example repository */ readonly origin: string; /** - * Format: date-time * @example 2018-08-17T04:18:39Z + * @format date-time */ readonly expires_at: string; }; @@ -24412,8 +24885,8 @@ export interface components { */ readonly "org-membership": { /** - * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt + * @format uri */ readonly url: string; /** @@ -24429,8 +24902,8 @@ export interface components { */ readonly role: "admin" | "member" | "billing_manager"; /** - * Format: uri * @example https://api.github.com/orgs/octocat + * @format uri */ readonly organization_url: string; readonly organization: components["schemas"]["organization-simple"]; @@ -24445,8 +24918,8 @@ export interface components { */ readonly migration: { /** - * Format: int64 * @example 79 + * @format int64 */ readonly id: number; readonly owner: components["schemas"]["nullable-simple-user"]; @@ -24465,22 +24938,22 @@ export interface components { /** @description The repositories included in the migration. Only returned for export migrations. */ readonly repositories: readonly components["schemas"]["repository"][]; /** - * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 + * @format uri */ readonly url: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ readonly updated_at: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly archive_url?: string; /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ readonly exclude?: readonly string[]; @@ -24491,20 +24964,25 @@ export interface components { */ readonly "organization-role": { /** - * Format: int64 * @description The unique identifier of the role. + * @format int64 */ 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. */ + /** + * @nullable + * @description A short description about who this role is for or what permissions it grants. + */ readonly description?: string | null; /** + * @nullable * @description The system role from which this role inherits permissions. * @enum {string|null} */ readonly base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; /** + * @nullable * @description Source answers the question, "where did this role come from?" * @enum {string|null} */ @@ -24513,13 +24991,13 @@ export interface components { readonly permissions: readonly string[]; readonly organization: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @description The date and time the role was created. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time the role was last updated. + * @format date-time */ readonly updated_at: string; }; @@ -24538,6 +25016,7 @@ export interface components { readonly node_id: string; readonly name: string; readonly slug: string; + /** @nullable */ readonly description: string | null; readonly privacy?: string; readonly notification_setting?: string; @@ -24549,15 +25028,15 @@ export interface components { readonly maintain: boolean; readonly admin: boolean; }; - /** Format: uri */ + /** @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; readonly members_url: string; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly parent: components["schemas"]["nullable-team-simple"]; }; @@ -24574,9 +25053,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ readonly node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ readonly url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -24587,6 +25066,7 @@ export interface components { */ readonly name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -24607,13 +25087,13 @@ export interface components { */ readonly notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ readonly repositories_url: string; /** @example justice-league */ @@ -24637,7 +25117,9 @@ export interface components { readonly assignment?: "direct" | "indirect" | "mixed"; /** @description Team the user has gotten the role through */ readonly inherited_from?: readonly components["schemas"]["team-simple"][]; + /** @nullable */ readonly name?: string | null; + /** @nullable */ readonly email?: string | null; /** @example octocat */ readonly login: string; @@ -24646,25 +25128,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -24674,25 +25159,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -24728,18 +25213,18 @@ export interface components { readonly license?: string; readonly description?: string; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly deleted_at?: string; /** Package Version Metadata */ @@ -24766,7 +25251,10 @@ export interface components { readonly "organization-programmatic-access-grant-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */ readonly id: number; - /** @description Reason for requesting access. */ + /** + * @nullable + * @description Reason for requesting access. + */ readonly reason: string | null; readonly owner: components["schemas"]["simple-user"]; /** @@ -24796,9 +25284,15 @@ export interface components { readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ readonly token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ readonly token_last_used_at: string | null; }; /** @@ -24836,9 +25330,15 @@ export interface components { readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ readonly token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ readonly token_last_used_at: string | null; }; /** @@ -24857,6 +25357,7 @@ export interface components { */ readonly registry_type: "maven_repository"; /** + * @nullable * @description The username to use when authenticating with the private registry. * @example monalisa */ @@ -24866,9 +25367,9 @@ export interface components { * @enum {string} */ readonly visibility: "all" | "private" | "selected"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -24898,9 +25399,9 @@ export interface components { readonly visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ readonly selected_repository_ids?: readonly number[]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -24909,23 +25410,23 @@ export interface components { */ readonly project: { /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test + * @format uri */ readonly owner_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604/columns + * @format uri */ readonly columns_url: string; /** @example 1002604 */ @@ -24938,6 +25439,7 @@ export interface components { */ readonly name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -24951,13 +25453,13 @@ export interface components { readonly state: string; readonly creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly updated_at: string; /** @@ -24976,8 +25478,8 @@ export interface components { /** @description The name of the property */ readonly property_name: string; /** - * Format: uri * @description The URL that can be used to fetch, update, or delete info about this property via the API. + * @format uri */ readonly url?: string; /** @@ -24994,16 +25496,24 @@ export interface components { readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ readonly required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ readonly default_value?: (string | readonly string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ readonly description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ readonly allowed_values?: readonly string[] | null; /** + * @nullable * @description Who can edit the values of the property * @example org_actors * @enum {string|null} @@ -25023,11 +25533,18 @@ export interface components { readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ readonly required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ readonly default_value?: (string | readonly string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ readonly description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ @@ -25040,7 +25557,10 @@ export interface components { readonly "custom-property-value": { /** @description The name of the property */ readonly property_name: string; - /** @description The value assigned to the property */ + /** + * @nullable + * @description The value assigned to the property + */ readonly value: (string | readonly string[]) | null; }; /** @@ -25059,13 +25579,14 @@ export interface components { }; /** * Repository + * @nullable * @description A repository on GitHub. */ readonly "nullable-repository": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25093,16 +25614,19 @@ export interface components { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25124,28 +25648,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25167,13 +25691,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25187,30 +25711,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25218,25 +25742,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -25308,18 +25835,21 @@ export interface components { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -25420,8 +25950,8 @@ export interface components { */ readonly "code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ readonly url: string; /** @example citizen_code_of_conduct */ @@ -25429,8 +25959,9 @@ export interface components { /** @example Citizen Code of Conduct */ readonly name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ readonly html_url: string | null; }; @@ -25440,8 +25971,8 @@ export interface components { */ readonly "full-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25453,16 +25984,19 @@ export interface components { readonly owner: components["schemas"]["simple-user"]; readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25484,28 +26018,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25527,13 +26061,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25547,30 +26081,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25578,25 +26112,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -25644,18 +26181,18 @@ export interface components { */ readonly visibility?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string; readonly permissions?: { @@ -25668,6 +26205,7 @@ export interface components { /** @example true */ readonly allow_rebase_merge?: boolean; readonly template_repository?: components["schemas"]["nullable-repository"]; + /** @nullable */ readonly temp_clone_token?: string | null; /** @example true */ readonly allow_squash_merge?: boolean; @@ -25757,7 +26295,10 @@ 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. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** + * @nullable + * @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + */ readonly actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -26238,16 +26779,18 @@ export interface components { /** @description The URL of the ruleset */ readonly href?: string; }; + /** @nullable */ readonly html?: { /** @description The html URL of the ruleset */ readonly href?: string; } | null; }; + /** @nullable */ readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; readonly rules?: readonly components["schemas"]["repository-rule"][]; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; }; /** @@ -26272,8 +26815,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ readonly repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at?: string; /** @@ -26294,9 +26837,15 @@ export interface components { readonly "rule-suite": { /** @description The unique identifier of the rule insight. */ readonly id?: number; - /** @description The number that identifies the user. */ + /** + * @nullable + * @description The number that identifies the user. + */ readonly actor_id?: number | null; - /** @description The handle for the GitHub user account. */ + /** + * @nullable + * @description The handle for the GitHub user account. + */ readonly actor_name?: string | null; /** @description The first commit sha before the push evaluation. */ readonly before_sha?: string; @@ -26309,8 +26858,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ readonly repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at?: string; /** @@ -26319,6 +26868,7 @@ export interface components { */ readonly result?: "pass" | "fail" | "bypass"; /** + * @nullable * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. * @enum {string|null} */ @@ -26328,9 +26878,15 @@ export interface components { readonly rule_source?: { /** @description The type of rule source. */ readonly type?: string; - /** @description The ID of the rule source. */ + /** + * @nullable + * @description The ID of the rule source. + */ readonly id?: number | null; - /** @description The name of the rule source. */ + /** + * @nullable + * @description The name of the rule source. + */ readonly name?: string | null; }; /** @@ -26345,23 +26901,41 @@ export interface components { readonly result?: "pass" | "fail"; /** @description The type of rule. */ readonly rule_type?: string; - /** @description The detailed failure message for the rule. Null if the rule passed. */ + /** + * @nullable + * @description The detailed failure message for the rule. Null if the rule passed. + */ readonly details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ readonly "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ readonly patched_versions: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ readonly vulnerable_functions: readonly string[] | null; }; /** @description A credit given to a user for a repository security advisory. */ @@ -26378,30 +26952,43 @@ export interface components { readonly "repository-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id: string | null; /** - * Format: uri * @description The API URL for the advisory. + * @format uri */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** @description A short summary of the advisory. */ readonly summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ readonly description: string | null; /** + * @nullable * @description The severity of the advisory. * @enum {string|null} */ readonly severity: "critical" | "high" | "medium" | "low" | null; - /** @description The author of the advisory. */ + /** + * @nullable + * @description The author of the advisory. + */ readonly author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ + /** + * @nullable + * @description The publisher of the advisory. + */ readonly publisher: components["schemas"]["simple-user"] | null; readonly identifiers: readonly { /** @@ -26418,61 +27005,90 @@ export interface components { */ readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was created, in ISO 8601 format. + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was closed, in ISO 8601 format. + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; + /** @nullable */ readonly submission: { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; + /** @nullable */ readonly vulnerabilities: readonly components["schemas"]["repository-advisory-vulnerability"][] | null; + /** @nullable */ readonly cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ readonly vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; readonly cvss_severities?: components["schemas"]["cvss-severities"]; + /** @nullable */ readonly cwes: readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ readonly cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description A list of only the CWE IDs. */ + /** + * @nullable + * @description A list of only the CWE IDs. + */ readonly cwe_ids: readonly string[] | null; + /** @nullable */ readonly credits: readonly { /** @description The username of the user credited. */ readonly login?: string; readonly type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; + /** @nullable */ readonly credits_detailed: readonly components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ + /** + * @nullable + * @description A list of users that collaborate on the advisory. + */ readonly collaborating_users: readonly components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ + /** + * @nullable + * @description A list of teams that collaborate on the advisory. + */ readonly collaborating_teams: readonly components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + /** + * @nullable + * @description A temporary private fork of the advisory's repository for collaborating on a fix. + */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; readonly "actions-billing-usage": { @@ -26557,9 +27173,10 @@ export interface components { */ readonly network_settings_ids?: readonly string[]; /** - * Format: date-time + * @nullable * @description The time at which the network configuration was created, in ISO 8601 format. * @example 2024-04-26T11:31:07Z + * @format date-time */ readonly created_on: string | null; }; @@ -26606,18 +27223,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -26630,25 +27247,31 @@ export interface components { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; /** @example github */ readonly name?: string; /** @example GitHub */ readonly company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ readonly blog?: string; /** @example San Francisco */ readonly location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ readonly email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ readonly twitter_username?: string | null; /** @example true */ readonly is_verified?: boolean; @@ -26665,13 +27288,13 @@ export interface components { /** @example 0 */ readonly following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ readonly created_at: string; /** @example Organization */ @@ -26680,15 +27303,25 @@ export interface components { readonly total_private_repos?: number; /** @example 100 */ readonly owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ readonly private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ readonly disk_usage?: number | null; - /** @example 8 */ + /** + * @nullable + * @example 8 + */ readonly collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ readonly billing_email?: string | null; readonly plan?: { @@ -26698,10 +27331,17 @@ export interface components { readonly filled_seats?: number; readonly seats?: number; }; + /** @nullable */ readonly default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly two_factor_requirement_enabled?: boolean | null; /** @example all */ readonly members_allowed_repository_creation_type?: string; @@ -26717,13 +27357,19 @@ export interface components { readonly members_can_create_public_pages?: boolean; /** @example true */ readonly members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ readonly members_can_fork_private_repositories?: boolean | null; /** @example false */ readonly web_commit_signoff_required?: boolean; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly archived_at: string | null; }; /** @@ -26739,14 +27385,14 @@ export interface components { /** @example MDQ6VGVhbTE= */ readonly node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ readonly html_url: string; /** @@ -26756,7 +27402,10 @@ export interface components { readonly name: string; /** @example justice-league */ readonly slug: string; - /** @example A great team. */ + /** + * @nullable + * @example A great team. + */ readonly description: string | null; /** * @description The level of privacy this team should have @@ -26778,8 +27427,8 @@ export interface components { /** @example https://api.github.com/organizations/1/team/1/members{/member} */ readonly members_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ readonly repositories_url: string; readonly parent?: components["schemas"]["nullable-team-simple"]; @@ -26788,13 +27437,13 @@ export interface components { /** @example 10 */ readonly repos_count: number; /** - * Format: date-time * @example 2017-07-14T16:53:42Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2017-08-17T12:37:15Z + * @format date-time */ readonly updated_at: string; readonly organization: components["schemas"]["team-organization"]; @@ -26825,20 +27474,23 @@ export interface components { /** @example 0 */ readonly comments_count: number; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments + * @format uri */ readonly comments_url: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly last_edited_at: string | null; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 + * @format uri */ readonly html_url: string; /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ @@ -26859,8 +27511,8 @@ export interface components { */ readonly private: boolean; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027 + * @format uri */ readonly team_url: string; /** @@ -26869,13 +27521,13 @@ export interface components { */ readonly title: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 + * @format uri */ readonly url: string; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -26899,20 +27551,23 @@ export interface components { */ readonly body_version: string; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly last_edited_at: string | null; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @format uri */ readonly discussion_url: string; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @format uri */ readonly html_url: string; /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ @@ -26923,13 +27578,13 @@ export interface components { */ readonly number: number; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + * @format uri */ readonly url: string; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -26951,8 +27606,8 @@ export interface components { */ readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** - * Format: date-time * @example 2016-05-20T20:09:31Z + * @format date-time */ readonly created_at: string; }; @@ -26961,7 +27616,7 @@ export interface components { * @description Team Membership */ readonly "team-membership": { - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description The role of the user in the team. @@ -26988,6 +27643,7 @@ export interface components { readonly id: number; readonly node_id: string; readonly name: string; + /** @nullable */ readonly body: string | null; readonly number: number; readonly state: string; @@ -27041,16 +27697,19 @@ export interface components { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -27072,28 +27731,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -27115,13 +27774,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -27135,30 +27794,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -27166,25 +27825,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -27246,18 +27908,21 @@ export interface components { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -27315,29 +27980,32 @@ export interface components { */ readonly "project-card": { /** - * Format: uri * @example https://api.github.com/projects/columns/cards/1478 + * @format uri */ readonly url: string; /** - * Format: int64 * @description The project card's ID * @example 42 + * @format int64 */ readonly id: number; /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ readonly node_id: string; - /** @example Add payload for delete Project column */ + /** + * @nullable + * @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 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2016-09-05T14:20:22Z + * @format date-time */ readonly updated_at: string; /** @@ -27348,18 +28016,18 @@ export interface components { readonly column_name?: string; readonly project_id?: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ readonly column_url: string; /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 + * @format uri */ readonly content_url?: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ readonly project_url: string; }; @@ -27369,18 +28037,18 @@ export interface components { */ readonly "project-column": { /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ readonly project_url: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367/cards + * @format uri */ readonly cards_url: string; /** @@ -27396,13 +28064,13 @@ export interface components { */ readonly name: string; /** - * Format: date-time * @example 2016-09-05T14:18:44Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2016-09-05T14:22:28Z + * @format date-time */ readonly updated_at: string; }; @@ -27466,12 +28134,22 @@ export interface components { readonly archive_download_url: string; /** @description Whether or not the artifact has expired. */ readonly expired: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly expires_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; + /** @nullable */ readonly workflow_run?: { /** @example 10 */ readonly id?: number; @@ -27506,13 +28184,13 @@ export interface components { /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ readonly version?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly last_accessed_at?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly created_at?: string; /** @example 1024 */ @@ -27550,7 +28228,10 @@ export interface components { readonly head_sha: string; /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ readonly url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ readonly html_url: string | null; /** * @description The phase of the lifecycle that the job is currently in. @@ -27559,27 +28240,29 @@ export interface components { */ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @description The outcome of the job. * @example success * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time * @description The time that the job created, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly started_at: string; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly completed_at: string | null; /** @@ -27596,6 +28279,7 @@ export interface components { */ readonly status: "queued" | "in_progress" | "completed"; /** + * @nullable * @description The outcome of the job. * @example success */ @@ -27608,15 +28292,17 @@ export interface components { /** @example 1 */ readonly number: number; /** - * Format: date-time + * @nullable * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly started_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ readonly completed_at?: string | null; }[]; @@ -27632,31 +28318,37 @@ export interface components { */ readonly labels: readonly string[]; /** + * @nullable * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ readonly runner_id: number | null; /** + * @nullable * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ readonly runner_name: string | null; /** + * @nullable * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ readonly runner_group_id: number | null; /** + * @nullable * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ readonly runner_group_name: string | null; /** + * @nullable * @description The name of the workflow. * @example Build */ readonly workflow_name: string | null; /** + * @nullable * @description The name of the current branch. * @example main */ @@ -27682,9 +28374,9 @@ export interface components { * @example SECRET_TOKEN */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** Actions Variable */ @@ -27700,15 +28392,15 @@ export interface components { */ readonly value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ readonly updated_at: string; }; @@ -27740,7 +28432,7 @@ export interface components { }; /** Pull Request Minimal */ readonly "pull-request-minimal": { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly number: number; readonly url: string; @@ -27748,7 +28440,7 @@ export interface components { readonly ref: string; readonly sha: string; readonly repo: { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly url: string; readonly name: string; @@ -27758,7 +28450,7 @@ export interface components { readonly ref: string; readonly sha: string; readonly repo: { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly url: string; readonly name: string; @@ -27767,6 +28459,7 @@ export interface components { }; /** * Simple Commit + * @nullable * @description A commit. */ readonly "nullable-simple-commit": { @@ -27783,12 +28476,15 @@ export interface components { */ readonly message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ readonly author: { /** * @description Name of the commit's author @@ -27796,13 +28492,16 @@ export interface components { */ readonly name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ readonly email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ readonly committer: { /** * @description Name of the commit's committer @@ -27810,9 +28509,9 @@ export interface components { */ readonly name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ readonly email: string; } | null; @@ -27828,6 +28527,7 @@ export interface components { */ readonly id: number; /** + * @nullable * @description The name of the workflow run. * @example Build */ @@ -27844,7 +28544,10 @@ export interface components { * @example MDEwOkNoZWNrU3VpdGU0Mg== */ readonly check_suite_node_id?: string; - /** @example master */ + /** + * @nullable + * @example master + */ readonly head_branch: string | null; /** * @description The SHA of the head commit that points to the version of the workflow being run. @@ -27866,12 +28569,19 @@ export interface components { * @example 1 */ readonly run_attempt?: number; + /** @nullable */ readonly referenced_workflows?: readonly components["schemas"]["referenced-workflow"][] | null; /** @example push */ readonly event: string; - /** @example completed */ + /** + * @nullable + * @example completed + */ readonly status: string | null; - /** @example neutral */ + /** + * @nullable + * @example neutral + */ readonly conclusion: string | null; /** * @description The ID of the parent workflow. @@ -27885,17 +28595,20 @@ export interface components { readonly url: string; /** @example https://github.com/github/hello-world/suites/4 */ readonly html_url: string; - /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */ + /** + * @nullable + * @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. + */ readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly actor?: components["schemas"]["simple-user"]; readonly triggering_actor?: components["schemas"]["simple-user"]; /** - * Format: date-time * @description The start time of the latest run. Resets on re-run. + * @format date-time */ readonly run_started_at?: string; /** @@ -27929,6 +28642,7 @@ export interface components { */ readonly rerun_url: string; /** + * @nullable * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ @@ -27973,15 +28687,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ readonly html_url?: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly created_at?: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly updated_at?: string; }[]; @@ -28028,9 +28742,9 @@ export interface components { readonly "pending-deployment": { readonly environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ readonly id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -28051,9 +28765,10 @@ export interface components { */ readonly wait_timer: number; /** - * Format: date-time + * @nullable * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly wait_timer_started_at: string | null; /** @@ -28073,14 +28788,14 @@ export interface components { */ readonly deployment: { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ readonly url: string; /** - * Format: int64 * @description Unique identifier of the deployment * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOkRlcGxveW1lbnQx */ @@ -28107,27 +28822,30 @@ export interface components { * @example production */ readonly environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ readonly description: string | null; readonly creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ readonly statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ readonly repository_url: string; /** @@ -28194,13 +28912,13 @@ export interface components { */ readonly state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ readonly updated_at: string; /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ @@ -28210,8 +28928,8 @@ export interface components { /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ readonly badge_url: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ readonly deleted_at?: string; }; @@ -28257,9 +28975,9 @@ export interface components { */ readonly ref: string; /** - * Format: date-time * @description The time when the activity occurred. * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly timestamp: string; /** @@ -28319,6 +29037,7 @@ export interface components { readonly contexts: readonly string[]; readonly checks: readonly { readonly context: string; + /** @nullable */ readonly app_id: number | null; }[]; readonly contexts_url?: string; @@ -28330,8 +29049,8 @@ export interface components { */ readonly "protected-branch-admin-enforced": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + * @format uri */ readonly url: string; /** @example true */ @@ -28343,8 +29062,8 @@ export interface components { */ readonly "protected-branch-pull-request-review": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + * @format uri */ readonly url?: string; readonly dismissal_restrictions?: { @@ -28388,17 +29107,17 @@ export interface components { * @description Branch Restriction Policy */ readonly "branch-restriction-policy": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly users_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri */ + /** @format uri */ readonly apps_url: string; readonly users: readonly { readonly login?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly node_id?: string; readonly avatar_url?: string; @@ -28425,12 +29144,14 @@ export interface components { readonly html_url?: string; readonly name?: string; readonly slug?: string; + /** @nullable */ readonly description?: string | null; readonly privacy?: string; readonly notification_setting?: string; readonly permission?: string; readonly members_url?: string; readonly repositories_url?: string; + /** @nullable */ readonly parent?: string | null; }[]; readonly apps: readonly { @@ -28523,8 +29244,8 @@ export interface components { readonly protection_url?: string; readonly required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ readonly url: string; /** @example true */ @@ -28549,16 +29270,17 @@ export interface components { readonly name: string; readonly commit: { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly protected: boolean; readonly protection?: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ readonly protection_url?: string; }; /** * Git User + * @nullable * @description Metaproperties for Git author/committer information. */ readonly "nullable-git-user": { @@ -28573,8 +29295,11 @@ export interface components { readonly verification: { readonly verified: boolean; readonly reason: string; + /** @nullable */ readonly payload: string | null; + /** @nullable */ readonly signature: string | null; + /** @nullable */ readonly verified_at?: string | null; }; /** @@ -28598,18 +29323,18 @@ export interface components { /** @example 124 */ readonly changes: number; /** - * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ readonly blob_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ readonly raw_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly contents_url: string; /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ @@ -28623,8 +29348,8 @@ export interface components { */ readonly commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly url: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ @@ -28632,19 +29357,19 @@ export interface components { /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ readonly node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + * @format uri */ readonly comments_url: string; readonly commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly url: string; readonly author: components["schemas"]["nullable-git-user"]; @@ -28657,26 +29382,28 @@ export interface components { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ readonly sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + * @format uri */ readonly url: string; }; readonly verification?: components["schemas"]["verification"]; }; + /** @nullable */ readonly author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + /** @nullable */ readonly committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; readonly parents: readonly { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ readonly html_url?: string; }[]; @@ -28696,12 +29423,12 @@ export interface components { readonly commit: components["schemas"]["commit"]; readonly _links: { readonly html: string; - /** Format: uri */ + /** @format uri */ readonly self: string; }; readonly protected: boolean; readonly protection: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ readonly protection_url: string; /** @example "mas*" */ readonly pattern?: string; @@ -28714,8 +29441,8 @@ export interface components { */ readonly "status-check-policy": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + * @format uri */ readonly url: string; /** @example true */ @@ -28729,11 +29456,12 @@ export interface components { readonly checks: readonly { /** @example continuous-integration/travis-ci */ readonly context: string; + /** @nullable */ readonly app_id: number | null; }[]; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + * @format uri */ readonly contexts_url: string; }; @@ -28742,11 +29470,11 @@ export interface components { * @description Branch protections protect branches */ readonly "protected-branch": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly required_status_checks?: components["schemas"]["status-check-policy"]; readonly required_pull_request_reviews?: { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly dismiss_stale_reviews?: boolean; readonly require_code_owner_reviews?: boolean; @@ -28757,11 +29485,11 @@ export interface components { */ readonly require_last_push_approval: boolean; readonly dismissal_restrictions?: { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly users_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly users: readonly components["schemas"]["simple-user"][]; readonly teams: readonly components["schemas"]["team"][]; @@ -28775,15 +29503,15 @@ export interface components { }; readonly required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ readonly url: string; /** @example true */ readonly enabled: boolean; }; readonly enforce_admins?: { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly enabled: boolean; }; @@ -28820,8 +29548,8 @@ export interface components { */ readonly "deployment-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ readonly url: string; /** @@ -28843,26 +29571,29 @@ export interface components { * @example production */ readonly environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ readonly description: string | null; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ readonly statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ readonly repository_url: string; /** @@ -28883,9 +29614,9 @@ export interface components { */ readonly "check-run": { /** - * Format: int64 * @description The id of the check. * @example 21 + * @format int64 */ readonly id: number; /** @@ -28895,13 +29626,22 @@ export interface components { readonly head_sha: string; /** @example MDg6Q2hlY2tSdW40 */ readonly node_id: string; - /** @example 42 */ + /** + * @nullable + * @example 42 + */ readonly external_id: string | null; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ readonly url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ readonly html_url: string | null; - /** @example https://example.com */ + /** + * @nullable + * @example https://example.com + */ readonly details_url: string | null; /** * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. @@ -28910,26 +29650,32 @@ export interface components { */ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @example neutral * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ readonly started_at: string | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ readonly completed_at: string | null; readonly output: { + /** @nullable */ readonly title: string | null; + /** @nullable */ readonly summary: string | null; + /** @nullable */ readonly text: string | null; readonly annotations_count: number; - /** Format: uri */ + /** @format uri */ readonly annotations_url: string; }; /** @@ -28937,6 +29683,7 @@ export interface components { * @example test-coverage */ readonly name: string; + /** @nullable */ readonly check_suite: { readonly id: number; } | null; @@ -28956,17 +29703,35 @@ export interface components { readonly start_line: number; /** @example 2 */ readonly end_line: number; - /** @example 5 */ + /** + * @nullable + * @example 5 + */ readonly start_column: number | null; - /** @example 10 */ + /** + * @nullable + * @example 10 + */ readonly end_column: number | null; - /** @example warning */ + /** + * @nullable + * @example warning + */ readonly annotation_level: string | null; - /** @example Spell Checker */ + /** + * @nullable + * @example Spell Checker + */ readonly title: string | null; - /** @example Check your spelling for 'banaas'. */ + /** + * @nullable + * @example Check your spelling for 'banaas'. + */ readonly message: string | null; - /** @example Do you mean 'bananas' or 'banana'? */ + /** + * @nullable + * @example Do you mean 'bananas' or 'banana'? + */ readonly raw_details: string | null; readonly blob_href: string; }; @@ -28988,12 +29753,15 @@ export interface components { */ readonly message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ readonly author: { /** * @description Name of the commit's author @@ -29001,13 +29769,16 @@ export interface components { */ readonly name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ readonly email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ readonly committer: { /** * @description Name of the commit's committer @@ -29015,9 +29786,9 @@ export interface components { */ readonly name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ readonly email: string; } | null; @@ -29028,13 +29799,16 @@ export interface components { */ readonly "check-suite": { /** - * Format: int64 * @example 5 + * @format int64 */ readonly id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ readonly node_id: string; - /** @example master */ + /** + * @nullable + * @example master + */ readonly head_branch: string | null; /** * @description The SHA of the head commit that is being checked. @@ -29042,28 +29816,46 @@ export interface components { */ readonly head_sha: string; /** + * @nullable * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; /** + * @nullable * @example neutral * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; - /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ + /** + * @nullable + * @example https://api.github.com/repos/github/hello-world/check-suites/5 + */ readonly url: string | null; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ readonly before: string | null; - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ readonly after: string | null; + /** @nullable */ readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; readonly app: components["schemas"]["nullable-integration"]; readonly repository: components["schemas"]["minimal-repository"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; readonly head_commit: components["schemas"]["simple-commit"]; readonly latest_check_runs_count: number; @@ -29102,16 +29894,21 @@ export interface components { readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; readonly "code-scanning-alert-rule": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ readonly id?: string | null; /** @description The name of the rule used to detect the alert. */ readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -29120,11 +29917,20 @@ export interface components { readonly description?: string; /** @description A description of the rule used to detect the alert. */ readonly full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ readonly tags?: readonly string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; }; readonly "code-scanning-alert": { @@ -29154,11 +29960,14 @@ export interface components { * @enum {string} */ readonly "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; - /** @description The description of an autofix. */ + /** + * @nullable + * @description The description of an autofix. + */ readonly "code-scanning-autofix-description": string | null; /** - * Format: date-time * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "code-scanning-autofix-started-at": string; readonly "code-scanning-autofix": { @@ -29166,7 +29975,10 @@ export interface components { readonly description: components["schemas"]["code-scanning-autofix-description"]; readonly started_at: components["schemas"]["code-scanning-autofix-started-at"]; }; - /** @description Commit an autofix for a code scanning alert */ + /** + * @nullable + * @description Commit an autofix for a code scanning alert + */ readonly "code-scanning-autofix-commits": { /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ readonly target_ref?: string; @@ -29184,18 +29996,21 @@ export interface components { * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ readonly "code-scanning-analysis-sarif-id": string; - /** @description The SHA of the commit to which the analysis you are uploading relates. */ + /** + * @description The SHA of the commit to which the analysis you are uploading relates. + * @pattern ^[0-9a-fA-F]+$ + */ readonly "code-scanning-analysis-commit-sha": string; /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ readonly "code-scanning-analysis-environment": string; /** - * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly "code-scanning-analysis-created-at": string; /** - * Format: uri * @description The REST API URL of the analysis resource. + * @format uri */ readonly "code-scanning-analysis-url": string; readonly "code-scanning-analysis": { @@ -29229,13 +30044,15 @@ export interface components { */ readonly "code-scanning-analysis-deletion": { /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, without last analysis deletion confirmation + * @format uri */ readonly next_analysis_url: string | null; /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, with last analysis deletion confirmation + * @format uri */ readonly confirm_delete_url: string | null; }; @@ -29256,21 +30073,24 @@ export interface components { /** @description The size of the CodeQL database file in bytes. */ readonly size: number; /** - * Format: date-time * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. + * @format uri */ readonly url: string; - /** @description The commit SHA of the repository at the time the CodeQL database was created. */ + /** + * @nullable + * @description The commit SHA of the repository at the time the CodeQL database was created. + */ readonly commit_oid?: string | null; }; /** @@ -29303,8 +30123,9 @@ export interface components { /** @example 80 */ readonly stargazers_count: number; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; }; @@ -29335,18 +30156,19 @@ export interface components { /** @description The download url for the query pack. */ readonly query_pack_url: string; /** - * Format: date-time * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly created_at?: string; /** - * Format: date-time * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly updated_at?: string; /** - * Format: date-time + * @nullable * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + * @format date-time */ readonly completed_at?: string | null; /** @enum {string} */ @@ -29410,11 +30232,13 @@ export interface components { /** @description Languages to be analyzed. */ readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** + * @nullable * @description Runner type to be used. * @enum {string|null} */ readonly runner_type?: "standard" | "labeled" | null; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29425,12 +30249,14 @@ export interface components { */ readonly query_suite?: "default" | "extended"; /** - * Format: date-time + * @nullable * @description Timestamp of latest configuration update. * @example 2023-12-06T14:20:20.000Z + * @format date-time */ readonly updated_at?: string | null; /** + * @nullable * @description The frequency of the periodic analysis. * @enum {string|null} */ @@ -29449,6 +30275,7 @@ export interface components { */ readonly runner_type?: "standard" | "labeled"; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29475,6 +30302,7 @@ export interface components { * @description The full Git reference, formatted as `refs/heads/`, * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main + * @pattern ^refs/(heads|tags|pull)/.*$ */ 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)." */ @@ -29482,8 +30310,8 @@ export interface components { readonly "code-scanning-sarifs-receipt": { readonly id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** - * Format: uri * @description The REST API URL for checking the status of the upload. + * @format uri */ readonly url?: string; }; @@ -29494,11 +30322,15 @@ export interface components { */ readonly processing_status?: "pending" | "complete" | "failed"; /** - * Format: uri + * @nullable * @description The REST API URL for getting the analyses associated with the upload. + * @format uri */ readonly analyses_url?: string | null; - /** @description Any errors that ocurred during processing of the delivery. */ + /** + * @nullable + * @description Any errors that ocurred during processing of the delivery. + */ readonly errors?: readonly string[] | null; }; /** @description Code security configuration associated with a repository and attachment status */ @@ -29537,6 +30369,7 @@ export interface components { */ readonly kind: string; /** + * @nullable * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. * @example The pattern `/` will never match anything, did you mean `*` instead? */ @@ -29592,6 +30425,7 @@ export interface components { */ readonly cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -29619,9 +30453,9 @@ export interface components { * @example SECRET_TOKEN */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -29632,34 +30466,39 @@ export interface components { /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; + /** @nullable */ readonly email?: string | null; + /** @nullable */ readonly name?: string | null; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29669,25 +30508,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -29711,9 +30550,9 @@ export interface components { */ readonly "repository-invitation": { /** - * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 + * @format int64 */ readonly id: number; readonly repository: components["schemas"]["minimal-repository"]; @@ -29726,8 +30565,8 @@ export interface components { */ readonly permissions: "read" | "write" | "admin" | "triage" | "maintain"; /** - * Format: date-time * @example 2016-06-13T14:52:50-05:00 + * @format date-time */ readonly created_at: string; /** @description Whether or not the invitation has expired */ @@ -29743,40 +30582,46 @@ export interface components { }; /** * Collaborator + * @nullable * @description Collaborator */ readonly "nullable-collaborator": { /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; + /** @nullable */ readonly email?: string | null; + /** @nullable */ readonly name?: string | null; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29786,25 +30631,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ @@ -29837,21 +30682,24 @@ export interface components { * @description Commit Comment */ readonly "commit-comment": { - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly id: number; readonly node_id: string; readonly body: string; + /** @nullable */ readonly path: string | null; + /** @nullable */ readonly position: number | null; + /** @nullable */ readonly line: number | null; readonly commit_id: string; readonly user: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly author_association: components["schemas"]["author-association"]; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -29877,6 +30725,7 @@ export interface components { }; /** * Auto merge + * @nullable * @description The status of auto merging a pull request. */ readonly "auto-merge": { @@ -29897,57 +30746,57 @@ export interface components { */ readonly "pull-request-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ readonly url: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ readonly node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ readonly diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ readonly patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ readonly issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ readonly commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ readonly review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ readonly review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ readonly comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly statuses_url: string; /** @example 1347 */ @@ -29959,10 +30808,13 @@ export interface components { /** @example new-feature */ readonly title: string; readonly user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ readonly body: string | null; readonly labels: readonly { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; readonly url: string; @@ -29972,33 +30824,44 @@ export interface components { readonly default: boolean; }[]; readonly milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ readonly active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ readonly merge_commit_sha: string | null; readonly assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; + /** @nullable */ readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; + /** @nullable */ readonly requested_teams?: readonly components["schemas"]["team"][] | null; readonly head: { readonly label: string; @@ -30034,21 +30897,29 @@ export interface components { }; /** Simple Commit Status */ readonly "simple-commit-status": { + /** @nullable */ readonly description: string | null; readonly id: number; readonly node_id: string; readonly state: string; readonly context: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly target_url: string | null; + /** @nullable */ readonly required?: boolean | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly avatar_url: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -30061,9 +30932,9 @@ export interface components { readonly sha: string; readonly total_count: number; readonly repository: components["schemas"]["minimal-repository"]; - /** Format: uri */ + /** @format uri */ readonly commit_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -30072,11 +30943,14 @@ export interface components { */ readonly status: { readonly url: string; + /** @nullable */ readonly avatar_url: string | null; readonly id: number; readonly node_id: string; readonly state: string; + /** @nullable */ readonly description: string | null; + /** @nullable */ readonly target_url: string | null; readonly context: string; readonly created_at: string; @@ -30085,12 +30959,13 @@ export interface components { }; /** * Code Of Conduct Simple + * @nullable * @description Code of Conduct Simple */ readonly "nullable-code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ readonly url: string; /** @example citizen_code_of_conduct */ @@ -30098,16 +30973,20 @@ export interface components { /** @example Citizen Code of Conduct */ readonly name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ readonly html_url: string | null; } | null; - /** Community Health File */ + /** + * Community Health File + * @nullable + */ readonly "nullable-community-health-file": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; } | null; /** @@ -30117,9 +30996,15 @@ export interface components { readonly "community-profile": { /** @example 100 */ readonly health_percentage: number; - /** @example My first repository on GitHub! */ + /** + * @nullable + * @example My first repository on GitHub! + */ readonly description: string | null; - /** @example example.com */ + /** + * @nullable + * @example example.com + */ readonly documentation: string | null; readonly files: { readonly code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; @@ -30131,8 +31016,9 @@ export interface components { readonly pull_request_template: components["schemas"]["nullable-community-health-file"]; }; /** - * Format: date-time + * @nullable * @example 2017-02-28T19:09:29Z + * @format date-time */ readonly updated_at: string | null; /** @example true */ @@ -30144,28 +31030,28 @@ export interface components { */ readonly "commit-comparison": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + * @format uri */ readonly permalink_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff + * @format uri */ readonly diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch + * @format uri */ readonly patch_url: string; readonly base_commit: components["schemas"]["commit"]; @@ -30195,13 +31081,22 @@ export interface components { readonly path: string; readonly sha: string; readonly content?: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly entries?: readonly { readonly type: string; @@ -30209,29 +31104,50 @@ export interface components { readonly name: string; readonly path: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }[]; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }; @@ -30247,20 +31163,35 @@ export interface components { readonly path: string; readonly content?: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }[]; @@ -30280,20 +31211,35 @@ export interface components { readonly path: string; readonly content: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; /** @example "actual/actual.md" */ @@ -30316,20 +31262,35 @@ export interface components { readonly name: string; readonly path: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }; @@ -30343,26 +31304,41 @@ export interface components { * @enum {string} */ readonly type: "submodule"; - /** Format: uri */ + /** @format uri */ readonly submodule_git_url: string; readonly size: number; readonly name: string; readonly path: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; }; @@ -30371,6 +31347,7 @@ export interface components { * @description File Commit */ readonly "file-commit": { + /** @nullable */ readonly content: { readonly name?: string; readonly path?: string; @@ -30415,8 +31392,11 @@ export interface components { readonly verification?: { readonly verified?: boolean; readonly reason?: string; + /** @nullable */ readonly signature?: string | null; + /** @nullable */ readonly payload?: string | null; + /** @nullable */ readonly verified_at?: string | null; }; }; @@ -30445,26 +31425,27 @@ export interface components { readonly login?: string; readonly id?: number; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; + /** @nullable */ readonly gravatar_id?: string | null; - /** Format: uri */ + /** @format uri */ readonly url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; readonly following_url?: string; readonly gists_url?: string; readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; readonly type: string; readonly site_admin?: boolean; @@ -30487,6 +31468,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -30501,11 +31483,15 @@ export interface components { readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; readonly dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ readonly dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ readonly dismissed_comment: string | null; readonly fixed_at: components["schemas"]["alert-fixed-at"]; readonly auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; @@ -30520,9 +31506,9 @@ export interface components { * @example MY_ARTIFACTORY_PASSWORD */ readonly name: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -30540,11 +31526,20 @@ export interface components { readonly name: string; /** @example 1.0.0 */ readonly version: string; - /** @example pkg:/npm/%40actions/core@1.1.0 */ + /** + * @nullable + * @example pkg:/npm/%40actions/core@1.1.0 + */ readonly package_url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ readonly license: string | null; - /** @example https://github.com/github/actions */ + /** + * @nullable + * @example https://github.com/github/actions + */ readonly source_repository_url: string | null; readonly vulnerabilities: readonly { /** @example critical */ @@ -30699,6 +31694,7 @@ export interface components { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. * @example pkg:/npm/%40actions/http-client@1.0.11 + * @pattern ^pkg */ readonly package_url?: string; readonly metadata?: components["schemas"]["metadata"]; @@ -30771,6 +31767,7 @@ export interface components { /** * @description The repository branch that triggered this snapshot. * @example refs/heads/main + * @pattern ^refs/ */ readonly ref: string; /** @description A description of the detector used. */ @@ -30797,9 +31794,9 @@ export interface components { readonly [key: string]: components["schemas"]["manifest"]; }; /** - * Format: date-time * @description The time at which the snapshot was scanned. * @example 2020-06-13T14:52:50-05:00 + * @format date-time */ readonly scanned: string; }; @@ -30809,13 +31806,13 @@ export interface components { */ readonly "deployment-status": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + * @format uri */ readonly url: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ @@ -30840,44 +31837,44 @@ export interface components { */ readonly environment: string; /** - * Format: uri * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ readonly target_url: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 + * @format uri */ readonly deployment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ readonly repository_url: string; /** - * Format: uri * @description The URL for accessing your environment. * @default * @example https://staging.example.com/ + * @format uri */ readonly environment_url: string; /** - * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ readonly log_url: string; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -30887,7 +31884,10 @@ export interface components { * @example 30 */ readonly "wait-timer": number; - /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ + /** + * @nullable + * @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. + */ readonly "deployment-branch-policy-settings": { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ readonly protected_branches: boolean; @@ -30900,9 +31900,9 @@ export interface components { */ readonly environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ readonly id: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -30917,15 +31917,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ readonly html_url: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ readonly updated_at: string; /** @description Built-in deployment protection rules for the environment. */ @@ -31084,9 +32084,10 @@ export interface components { readonly blob: { readonly content: string; readonly encoding: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly sha: string; + /** @nullable */ readonly size: number | null; readonly node_id: string; readonly highlighted_content?: string; @@ -31102,14 +32103,14 @@ export interface components { */ readonly sha: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @description Identifying information for the git-user */ readonly author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly date: string; /** @@ -31126,9 +32127,9 @@ export interface components { /** @description Identifying information for the git-user */ readonly committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly date: string; /** @@ -31153,7 +32154,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly parents: readonly { @@ -31162,19 +32163,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; }[]; readonly verification: { readonly verified: boolean; readonly reason: string; + /** @nullable */ readonly signature: string | null; + /** @nullable */ readonly payload: string | null; + /** @nullable */ readonly verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; }; /** @@ -31184,7 +32188,7 @@ export interface components { readonly "git-ref": { readonly ref: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly object: { readonly type: string; @@ -31193,7 +32197,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; }; @@ -31212,9 +32216,9 @@ export interface components { /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ readonly sha: string; /** - * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + * @format uri */ readonly url: string; /** @@ -31230,7 +32234,7 @@ export interface components { readonly object: { readonly sha: string; readonly type: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly verification?: components["schemas"]["verification"]; @@ -31241,7 +32245,7 @@ export interface components { */ readonly "git-tree": { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly truncated: boolean; /** @@ -31302,8 +32306,11 @@ export interface components { }; /** Hook Response */ readonly "hook-response": { + /** @nullable */ readonly code: number | null; + /** @nullable */ readonly status: string | null; + /** @nullable */ readonly message: string | null; }; /** @@ -31337,33 +32344,33 @@ export interface components { readonly events: readonly string[]; readonly config: components["schemas"]["webhook-config"]; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ readonly created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test + * @format uri */ readonly test_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + * @format uri */ readonly ping_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries + * @format uri */ readonly deliveries_url?: string; readonly last_response: components["schemas"]["hook-response"]; @@ -31373,6 +32380,7 @@ export interface components { * @description A repository import from an external source. */ readonly import: { + /** @nullable */ readonly vcs: string | null; readonly use_lfs?: boolean; /** @description The URL of the originating repository. */ @@ -31381,11 +32389,17 @@ export interface components { readonly tfvc_project?: string; /** @enum {string} */ readonly status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; + /** @nullable */ readonly status_text?: string | null; + /** @nullable */ readonly failed_step?: string | null; + /** @nullable */ readonly error_message?: string | null; + /** @nullable */ readonly import_percent?: number | null; + /** @nullable */ readonly commit_count?: number | null; + /** @nullable */ readonly push_percent?: number | null; readonly has_large_files?: boolean; readonly large_files_size?: number; @@ -31396,14 +32410,15 @@ export interface components { readonly human_name?: string; }[]; readonly message?: string; + /** @nullable */ readonly authors_count?: number | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly authors_url: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly svn_root?: string; }; @@ -31417,9 +32432,9 @@ export interface components { readonly remote_name: string; readonly email: string; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly import_url: string; }; /** @@ -31434,26 +32449,27 @@ export interface components { }; /** * Issue + * @nullable * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ readonly "nullable-issue": { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -31466,6 +32482,7 @@ export interface components { */ readonly state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -31477,6 +32494,7 @@ export interface components { */ readonly title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -31490,45 +32508,67 @@ export interface components { * ] */ readonly labels: readonly (string | { - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly name?: string; + /** @nullable */ readonly description?: string | null; + /** @nullable */ readonly color?: string | null; readonly default?: boolean; })[]; readonly assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; readonly milestone: components["schemas"]["nullable-milestone"]; readonly locked: boolean; + /** @nullable */ readonly active_lock_reason?: string | null; readonly comments: number; readonly pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly draft?: boolean; readonly closed_by?: components["schemas"]["nullable-simple-user"]; readonly body_html?: string; readonly body_text?: string; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; readonly repository?: components["schemas"]["repository"]; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -31541,14 +32581,18 @@ export interface components { * @description Issue Event Label */ readonly "issue-event-label": { + /** @nullable */ readonly name: string | null; + /** @nullable */ readonly color: string | null; }; /** Issue Event Dismissed Review */ readonly "issue-event-dismissed-review": { readonly state: string; readonly review_id: number; + /** @nullable */ readonly dismissal_message: string | null; + /** @nullable */ readonly dismissal_commit_id?: string | null; }; /** @@ -31563,10 +32607,10 @@ export interface components { * @description Issue Event Project Card */ readonly "issue-event-project-card": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly project_id: number; readonly column_name: string; @@ -31586,27 +32630,33 @@ export interface components { */ readonly "issue-event": { /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDEwOklzc3VlRXZlbnQx */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 + * @format uri */ readonly url: string; readonly actor: components["schemas"]["nullable-simple-user"]; /** @example closed */ readonly event: string; - /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e + */ readonly commit_id: string | null; - /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ readonly commit_url: string | null; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; readonly issue?: components["schemas"]["nullable-issue"]; @@ -31621,6 +32671,7 @@ export interface components { readonly project_card?: components["schemas"]["issue-event-project-card"]; readonly rename?: components["schemas"]["issue-event-rename"]; readonly author_association?: components["schemas"]["author-association"]; + /** @nullable */ readonly lock_reason?: string | null; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; }; @@ -31634,7 +32685,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31653,7 +32706,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31672,7 +32727,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["integration"]; @@ -31689,7 +32746,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31706,7 +32765,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31724,7 +32785,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31742,7 +32805,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31761,7 +32826,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31779,7 +32846,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31797,13 +32866,16 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; readonly dismissed_review: { readonly state: string; readonly review_id: number; + /** @nullable */ readonly dismissal_message: string | null; readonly dismissal_commit_id?: string; }; @@ -31818,11 +32890,16 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - /** @example "off-topic" */ + /** + * @nullable + * @example "off-topic" + */ readonly lock_reason: string | null; }; /** @@ -31835,16 +32912,18 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; readonly project_card?: { readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly project_id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly column_name: string; readonly previous_column_name?: string; @@ -31860,16 +32939,18 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; readonly project_card?: { readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly project_id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly column_name: string; readonly previous_column_name?: string; @@ -31885,16 +32966,18 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; readonly project_card?: { readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly project_id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly column_name: string; readonly previous_column_name?: string; @@ -31910,16 +32993,18 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["integration"]; readonly project_card?: { readonly id: number; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly project_id: number; - /** Format: uri */ + /** @format uri */ readonly project_url: string; readonly column_name: string; readonly previous_column_name?: string; @@ -31936,17 +33021,17 @@ export interface components { */ readonly label: { /** - * Format: int64 * @description Unique identifier for the label. * @example 208045946 + * @format int64 */ readonly id: number; /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ readonly node_id: string; /** - * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug + * @format uri */ readonly url: string; /** @@ -31955,6 +33040,7 @@ export interface components { */ readonly name: string; /** + * @nullable * @description Optional description of the label, such as its purpose. * @example Something isn't working */ @@ -31984,9 +33070,9 @@ export interface components { readonly id: number; readonly node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ readonly url: string; /** @@ -31996,20 +33082,20 @@ export interface components { readonly body?: string; readonly body_text?: string; readonly body_html?: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly user: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly author_association: components["schemas"]["author-association"]; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -32022,9 +33108,9 @@ export interface components { readonly "timeline-cross-referenced-event": { readonly event: string; readonly actor?: components["schemas"]["simple-user"]; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly source: { readonly type?: string; @@ -32043,14 +33129,14 @@ export interface components { */ readonly sha: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @description Identifying information for the git-user */ readonly author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly date: string; /** @@ -32067,9 +33153,9 @@ export interface components { /** @description Identifying information for the git-user */ readonly committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ readonly date: string; /** @@ -32094,7 +33180,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly parents: readonly { @@ -32103,19 +33189,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; }[]; readonly verification: { readonly verified: boolean; readonly reason: string; + /** @nullable */ readonly signature: string | null; + /** @nullable */ readonly payload: string | null; + /** @nullable */ readonly verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; }; /** @@ -32133,6 +33222,7 @@ export interface components { readonly node_id: string; readonly user: components["schemas"]["simple-user"]; /** + * @nullable * @description The text of the review. * @example This looks great. */ @@ -32140,13 +33230,13 @@ export interface components { /** @example CHANGES_REQUESTED */ readonly state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ readonly pull_request_url: string; readonly _links: { @@ -32157,7 +33247,7 @@ export interface components { readonly href: string; }; }; - /** Format: date-time */ + /** @format date-time */ readonly submitted_at?: string; /** * @description A commit SHA for the review. @@ -32179,15 +33269,16 @@ export interface components { */ readonly url: string; /** - * Format: int64 + * @nullable * @description The ID of the pull request review to which the comment belongs. * @example 42 + * @format int64 */ readonly pull_request_review_id: number | null; /** - * Format: int64 * @description The ID of the pull request review comment. * @example 1 + * @format int64 */ readonly id: number; /** @@ -32237,62 +33328,65 @@ export interface components { */ readonly body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ readonly html_url: string; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ readonly pull_request_url: string; readonly author_association: components["schemas"]["author-association"]; readonly _links: { readonly self: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ readonly href: string; }; readonly html: { /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ readonly href: string; }; readonly pull_request: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ readonly href: string; }; }; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ readonly start_line?: number | null; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ readonly original_start_line?: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -32354,7 +33448,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32370,7 +33466,9 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32386,10 +33484,13 @@ export interface components { readonly url: string; readonly actor: components["schemas"]["simple-user"]; readonly event: string; + /** @nullable */ readonly commit_id: string | null; + /** @nullable */ readonly commit_url: string | null; readonly created_at: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + /** @nullable */ readonly state_reason?: string | null; }; /** @@ -32409,7 +33510,9 @@ export interface components { readonly verified: boolean; readonly created_at: string; readonly read_only: boolean; + /** @nullable */ readonly added_by?: string | null; + /** @nullable */ readonly last_used?: string | null; readonly enabled?: boolean; }; @@ -32429,23 +33532,38 @@ export interface components { readonly path: string; readonly sha: string; readonly size: number; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly download_url: string | null; readonly type: string; readonly content: string; readonly encoding: string; readonly _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html: string | null; - /** Format: uri */ + /** @format uri */ readonly self: string; }; readonly license: components["schemas"]["nullable-license-simple"]; @@ -32466,18 +33584,18 @@ export interface components { */ readonly milestone: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ readonly labels_url: string; /** @example 1002604 */ @@ -32501,7 +33619,10 @@ export interface components { * @example v1.0 */ readonly title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ readonly description: string | null; readonly creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -32509,23 +33630,25 @@ export interface components { /** @example 8 */ readonly closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ readonly due_on: string | null; }; @@ -32551,7 +33674,7 @@ export interface components { * ] */ readonly domains: readonly string[]; - /** Format: date */ + /** @format date */ readonly expires_at?: string; }; /** @@ -32560,31 +33683,35 @@ export interface components { */ readonly page: { /** - * Format: uri * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages + * @format uri */ readonly url: string; /** + * @nullable * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ readonly status: "built" | "building" | "errored" | null; /** + * @nullable * @description The Pages site's custom domain * @example example.com */ readonly cname: string | null; /** + * @nullable * @description The state if the domain is verified * @example pending * @enum {string|null} */ readonly protected_domain_state?: "pending" | "verified" | "unverified" | null; /** - * Format: date-time + * @nullable * @description The timestamp when a pending domain becomes unverified. + * @format date-time */ readonly pending_domain_unverified_at?: string | null; /** @@ -32594,12 +33721,13 @@ export interface components { */ readonly custom_404: boolean; /** - * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com + * @format uri */ readonly html_url?: string; /** + * @nullable * @description The process in which the Page will be built. * @example legacy * @enum {string|null} @@ -32623,18 +33751,19 @@ export interface components { * @description Page Build */ readonly "page-build": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly status: string; readonly error: { + /** @nullable */ readonly message: string | null; }; readonly pusher: components["schemas"]["nullable-simple-user"]; readonly commit: string; readonly duration: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @@ -32643,8 +33772,8 @@ export interface components { */ readonly "page-build-status": { /** - * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest + * @format uri */ readonly url: string; /** @example queued */ @@ -32658,21 +33787,21 @@ export interface components { /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ readonly id: number | string; /** - * Format: uri * @description The URI to monitor GitHub Pages deployment status. * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 + * @format uri */ readonly status_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages. * @example hello-world.github.io + * @format uri */ readonly page_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages preview. * @example monalisa-1231a2312sa32-23sda74.drafts.github.io + * @format uri */ readonly preview_url?: string; }; @@ -32694,59 +33823,96 @@ export interface components { readonly uri?: string; readonly nameservers?: string; readonly dns_resolves?: boolean; + /** @nullable */ readonly is_proxied?: boolean | null; + /** @nullable */ readonly is_cloudflare_ip?: boolean | null; + /** @nullable */ readonly is_fastly_ip?: boolean | null; + /** @nullable */ readonly is_old_ip_address?: boolean | null; + /** @nullable */ readonly is_a_record?: boolean | null; + /** @nullable */ readonly has_cname_record?: boolean | null; + /** @nullable */ readonly has_mx_records_present?: boolean | null; readonly is_valid_domain?: boolean; readonly is_apex_domain?: boolean; + /** @nullable */ readonly should_be_a_record?: boolean | null; + /** @nullable */ readonly is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ readonly is_cname_to_fastly?: boolean | null; + /** @nullable */ readonly is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ readonly is_non_github_pages_ip_present?: boolean | null; readonly is_pages_domain?: boolean; + /** @nullable */ readonly is_served_by_pages?: boolean | null; readonly is_valid?: boolean; + /** @nullable */ readonly reason?: string | null; readonly responds_to_https?: boolean; readonly enforces_https?: boolean; + /** @nullable */ readonly https_error?: string | null; + /** @nullable */ readonly is_https_eligible?: boolean | null; + /** @nullable */ readonly caa_error?: string | null; }; + /** @nullable */ readonly alt_domain?: { readonly host?: string; readonly uri?: string; readonly nameservers?: string; readonly dns_resolves?: boolean; + /** @nullable */ readonly is_proxied?: boolean | null; + /** @nullable */ readonly is_cloudflare_ip?: boolean | null; + /** @nullable */ readonly is_fastly_ip?: boolean | null; + /** @nullable */ readonly is_old_ip_address?: boolean | null; + /** @nullable */ readonly is_a_record?: boolean | null; + /** @nullable */ readonly has_cname_record?: boolean | null; + /** @nullable */ readonly has_mx_records_present?: boolean | null; readonly is_valid_domain?: boolean; readonly is_apex_domain?: boolean; + /** @nullable */ readonly should_be_a_record?: boolean | null; + /** @nullable */ readonly is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ readonly is_cname_to_fastly?: boolean | null; + /** @nullable */ readonly is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ readonly is_non_github_pages_ip_present?: boolean | null; readonly is_pages_domain?: boolean; + /** @nullable */ readonly is_served_by_pages?: boolean | null; readonly is_valid?: boolean; + /** @nullable */ readonly reason?: string | null; readonly responds_to_https?: boolean; readonly enforces_https?: boolean; + /** @nullable */ readonly https_error?: string | null; + /** @nullable */ readonly is_https_eligible?: boolean | null; + /** @nullable */ readonly caa_error?: string | null; } | null; }; @@ -32756,57 +33922,57 @@ export interface components { */ readonly "pull-request": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ readonly url: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ readonly node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ readonly diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ readonly patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ readonly issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ readonly commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ readonly review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ readonly review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ readonly comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ readonly statuses_url: string; /** @@ -32828,46 +33994,61 @@ export interface components { */ readonly title: string; readonly user: components["schemas"]["simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ readonly body: string | null; readonly labels: readonly { - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; readonly url: string; readonly name: string; + /** @nullable */ readonly description: string | null; readonly color: string; readonly default: boolean; }[]; readonly milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ readonly active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ readonly merge_commit_sha: string | null; readonly assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; + /** @nullable */ readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; + /** @nullable */ readonly requested_teams?: readonly components["schemas"]["team-simple"][] | null; readonly head: { readonly label: string; @@ -32901,9 +34082,15 @@ export interface components { */ readonly draft?: boolean; readonly merged: boolean; - /** @example true */ + /** + * @nullable + * @example true + */ readonly mergeable: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ readonly rebaseable?: boolean | null; /** @example clean */ readonly mergeable_state: string; @@ -32949,9 +34136,9 @@ export interface components { */ readonly "pull-request-review": { /** - * Format: int64 * @description Unique identifier of the review * @example 42 + * @format int64 */ readonly id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ @@ -32965,13 +34152,13 @@ export interface components { /** @example CHANGES_REQUESTED */ readonly state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ readonly pull_request_url: string; readonly _links: { @@ -32982,9 +34169,10 @@ export interface components { readonly href: string; }; }; - /** Format: date-time */ + /** @format date-time */ readonly submitted_at?: string; /** + * @nullable * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ @@ -32999,18 +34187,19 @@ export interface components { */ readonly "review-comment": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ readonly url: string; /** - * Format: int64 + * @nullable * @example 42 + * @format int64 */ readonly pull_request_review_id: number | null; /** - * Format: int64 * @example 10 + * @format int64 */ readonly id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ @@ -33019,7 +34208,10 @@ export interface components { readonly diff_hunk: string; /** @example file1.txt */ readonly path: string; - /** @example 1 */ + /** + * @nullable + * @example 1 + */ readonly position: number | null; /** @example 4 */ readonly original_position: number; @@ -33033,23 +34225,23 @@ export interface components { /** @example Great stuff */ readonly body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ readonly updated_at: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ readonly pull_request_url: string; readonly author_association: components["schemas"]["author-association"]; @@ -33068,6 +34260,7 @@ export interface components { */ readonly side: "LEFT" | "RIGHT"; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -33084,11 +34277,13 @@ export interface components { */ readonly original_line?: number; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ readonly start_line?: number | null; /** + * @nullable * @description The original first line of the range for a multi-line comment. * @example 2 */ @@ -33099,9 +34294,9 @@ export interface components { * @description Data related to a release. */ readonly "release-asset": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly browser_download_url: string; readonly id: number; readonly node_id: string; @@ -33110,6 +34305,7 @@ export interface components { * @example Team Environment */ readonly name: string; + /** @nullable */ readonly label: string | null; /** * @description State of the release asset. @@ -33119,9 +34315,9 @@ export interface components { readonly content_type: string; readonly size: number; readonly download_count: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly uploader: components["schemas"]["nullable-simple-user"]; }; @@ -33130,16 +34326,22 @@ export interface components { * @description A release. */ readonly release: { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly assets_url: string; readonly upload_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly tarball_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly zipball_url: string | null; readonly id: number; readonly node_id: string; @@ -33153,7 +34355,9 @@ export interface components { * @example master */ readonly target_commitish: string; + /** @nullable */ readonly name: string | null; + /** @nullable */ readonly body?: string | null; /** * @description true to create a draft (unpublished) release, false to create a published one. @@ -33165,9 +34369,12 @@ export interface components { * @example false */ readonly prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly published_at: string | null; readonly author: components["schemas"]["simple-user"]; readonly assets: readonly components["schemas"]["release-asset"][]; @@ -33175,8 +34382,8 @@ export interface components { readonly body_text?: string; readonly mentions_count?: number; /** - * Format: uri * @description The URL of the release discussion. + * @format uri */ readonly discussion_url?: string; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -33221,19 +34428,23 @@ export interface components { readonly url?: components["schemas"]["alert-url"]; readonly html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ readonly locations_url?: string; readonly state?: components["schemas"]["secret-scanning-alert-state"]; readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly resolved_at?: string | null; readonly resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ readonly resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; @@ -33244,22 +34455,33 @@ export interface components { readonly secret_type_display_name?: string; /** @description The secret that was detected. */ readonly secret?: string; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ readonly push_protection_bypassed?: boolean | null; readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly push_protection_bypassed_at?: string | null; readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ readonly push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ readonly push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ readonly push_protection_bypass_request_html_url?: string | null; /** @@ -33267,12 +34489,21 @@ export interface components { * @enum {string} */ readonly validity?: "active" | "inactive" | "unknown"; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ readonly publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. + */ readonly multi_repo?: boolean | null; }; - /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ + /** + * @nullable + * @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. + */ readonly "secret-scanning-alert-resolution-comment": string | null; /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ readonly "secret-scanning-location-commit": { @@ -33343,99 +34574,99 @@ export interface components { /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ readonly "secret-scanning-location-issue-title": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ readonly issue_title_url: string; }; /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ readonly "secret-scanning-location-issue-body": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ readonly issue_body_url: string; }; /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ readonly "secret-scanning-location-issue-comment": { /** - * Format: uri * @description The API URL to get the issue comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ readonly issue_comment_url: string; }; /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ readonly "secret-scanning-location-discussion-title": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082 + * @format uri */ readonly discussion_title_url: string; }; /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ readonly "secret-scanning-location-discussion-body": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussion-4566270 + * @format uri */ readonly discussion_body_url: string; }; /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ readonly "secret-scanning-location-discussion-comment": { /** - * Format: uri * @description The API URL to get the discussion comment where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + * @format uri */ readonly discussion_comment_url: string; }; /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ readonly "secret-scanning-location-pull-request-title": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ readonly pull_request_title_url: string; }; /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ readonly "secret-scanning-location-pull-request-body": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ readonly pull_request_body_url: string; }; /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ readonly "secret-scanning-location-pull-request-comment": { /** - * Format: uri * @description The API URL to get the pull request comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ readonly pull_request_comment_url: string; }; /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ readonly "secret-scanning-location-pull-request-review": { /** - * Format: uri * @description The API URL to get the pull request review where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + * @format uri */ readonly pull_request_review_url: string; }; /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ readonly "secret-scanning-location-pull-request-review-comment": { /** - * Format: uri * @description The API URL to get the pull request review comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + * @format uri */ readonly pull_request_review_comment_url: string; }; @@ -33456,8 +34687,9 @@ export interface components { readonly "secret-scanning-push-protection-bypass": { readonly reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** - * Format: date-time + * @nullable * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly expire_at?: string | null; /** @description The token type this bypass is for. */ @@ -33470,13 +34702,15 @@ export interface components { /** @description The state of the scan. Either "completed", "running", or "pending" */ readonly status?: string; /** - * Format: date-time + * @nullable * @description The time that the scan was completed. Empty if the scan is running + * @format date-time */ readonly completed_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the scan was started. Empty if the scan is pending + * @format date-time */ readonly started_at?: string | null; }; @@ -33496,37 +34730,62 @@ export interface components { readonly summary: string; /** @description A detailed description of what the advisory impacts. */ readonly description: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ readonly vulnerabilities: readonly { /** @description The name of the package affected by the vulnerability. */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ readonly patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ readonly vulnerable_functions?: readonly string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ readonly cwe_ids?: readonly string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ readonly credits?: readonly { /** @description The username of the user credited. */ readonly login: string; readonly type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ readonly severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ readonly cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33539,29 +34798,51 @@ export interface components { readonly summary: string; /** @description A detailed description of what the advisory impacts. */ readonly description: string; - /** @description An array of products affected by the vulnerability detailed in a repository security advisory. */ + /** + * @nullable + * @description An array of products affected by the vulnerability detailed in a repository security advisory. + */ readonly vulnerabilities?: readonly { /** @description The name of the package affected by the vulnerability. */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ readonly patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ readonly vulnerable_functions?: readonly string[] | null; }[] | null; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ readonly cwe_ids?: readonly string[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ readonly severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ readonly cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33574,46 +34855,77 @@ export interface components { readonly summary?: string; /** @description A detailed description of what the advisory impacts. */ readonly description?: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ readonly vulnerabilities?: readonly { /** @description The name of the package affected by the vulnerability. */ readonly package: { readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ readonly name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ readonly vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ readonly patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ readonly vulnerable_functions?: readonly string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ readonly cwe_ids?: readonly string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ readonly credits?: readonly { /** @description The username of the user credited. */ readonly login: string; readonly type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ readonly severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ readonly cvss_vector_string?: string | null; /** * @description The state of the advisory. * @enum {string} */ readonly state?: "published" | "closed" | "draft"; - /** @description A list of usernames who have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of usernames who have been granted write access to the advisory. + */ readonly collaborating_users?: readonly string[] | null; - /** @description A list of team slugs which have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of team slugs which have been granted write access to the advisory. + */ readonly collaborating_teams?: readonly string[] | null; }; /** @@ -33621,7 +34933,7 @@ export interface components { * @description Stargazer */ readonly stargazer: { - /** Format: date-time */ + /** @format date-time */ readonly starred_at: string; readonly user: components["schemas"]["nullable-simple-user"]; }; @@ -33694,20 +35006,21 @@ export interface components { readonly subscribed: boolean; /** @description Determines if all notifications should be blocked from this repository. */ readonly ignored: boolean; + /** @nullable */ readonly reason: string | null; /** - * Format: date-time * @example 2012-10-06T21:34:12Z + * @format date-time */ readonly created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/subscription + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ readonly repository_url: string; }; @@ -33720,17 +35033,17 @@ export interface components { readonly name: string; readonly commit: { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** - * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 + * @format uri */ readonly zipball_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 + * @format uri */ readonly tarball_url: string; readonly node_id: string; @@ -33760,7 +35073,7 @@ export interface components { }; /** Traffic */ readonly traffic: { - /** Format: date-time */ + /** @format date-time */ readonly timestamp: string; readonly uniques: number; readonly count: number; @@ -33816,6 +35129,7 @@ export interface components { /** Search Result Text Matches */ readonly "search-result-text-matches": readonly { readonly object_url?: string; + /** @nullable */ readonly object_type?: string | null; readonly property?: string; readonly fragment?: string; @@ -33832,17 +35146,18 @@ export interface components { readonly name: string; readonly path: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly repository: components["schemas"]["minimal-repository"]; readonly score: number; readonly file_size?: number; + /** @nullable */ readonly language?: string | null; - /** Format: date-time */ + /** @format date-time */ readonly last_modified_at?: string; /** * @example [ @@ -33858,18 +35173,18 @@ export interface components { * @description Commit Search Result Item */ readonly "commit-search-result-item": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commit: { readonly author: { readonly name: string; readonly email: string; - /** Format: date-time */ + /** @format date-time */ readonly date: string; }; readonly committer: components["schemas"]["nullable-git-user"]; @@ -33877,10 +35192,10 @@ export interface components { readonly message: string; readonly tree: { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly verification?: components["schemas"]["verification"]; }; @@ -33901,34 +35216,37 @@ export interface components { * @description Issue Search Result Item */ readonly "issue-search-result-item": { - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; readonly number: number; readonly title: string; readonly locked: boolean; + /** @nullable */ readonly active_lock_reason?: string | null; + /** @nullable */ readonly assignees?: readonly components["schemas"]["simple-user"][] | null; readonly user: components["schemas"]["nullable-simple-user"]; readonly labels: readonly { - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly node_id?: string; readonly url?: string; readonly name?: string; readonly color?: string; readonly default?: boolean; + /** @nullable */ readonly description?: string | null; }[]; /** Sub-issues Summary */ @@ -33938,27 +35256,46 @@ export interface components { readonly percent_completed: number; }; readonly state: string; + /** @nullable */ readonly state_reason?: string | null; readonly assignee: components["schemas"]["nullable-simple-user"]; readonly milestone: components["schemas"]["nullable-milestone"]; readonly comments: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly text_matches?: components["schemas"]["search-result-text-matches"]; readonly pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; }; readonly body?: string; @@ -33968,7 +35305,7 @@ export interface components { readonly repository?: components["schemas"]["repository"]; readonly body_html?: string; readonly body_text?: string; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; readonly reactions?: components["schemas"]["reaction-rollup"]; @@ -33980,11 +35317,12 @@ export interface components { readonly "label-search-result-item": { readonly id: number; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly name: string; readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly score: number; readonly text_matches?: components["schemas"]["search-result-text-matches"]; @@ -34000,58 +35338,63 @@ export interface components { readonly full_name: string; readonly owner: components["schemas"]["nullable-simple-user"]; readonly private: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; + /** @nullable */ readonly description: string | null; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: date-time */ + /** @format date-time */ readonly pushed_at: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly homepage: string | null; readonly size: number; readonly stargazers_count: number; readonly watchers_count: number; + /** @nullable */ readonly language: string | null; readonly forks_count: number; readonly open_issues_count: number; readonly master_branch?: string; readonly default_branch: string; readonly score: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly keys_url: string; readonly collaborators_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; readonly issue_events_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly assignees_url: string; readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; readonly blobs_url: string; readonly git_tags_url: string; readonly git_refs_url: string; readonly trees_url: string; readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; readonly commits_url: string; readonly git_commits_url: string; @@ -34059,10 +35402,10 @@ export interface components { readonly issue_comment_url: string; readonly contents_url: string; readonly compare_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; readonly archive_url: string; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; readonly issues_url: string; readonly pulls_url: string; @@ -34070,18 +35413,21 @@ export interface components { readonly notifications_url: string; readonly labels_url: string; readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; readonly git_url: string; readonly ssh_url: string; readonly clone_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; readonly forks: number; readonly open_issues: number; readonly watchers: number; readonly topics?: readonly string[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; readonly has_issues: boolean; readonly has_projects: boolean; @@ -34120,22 +35466,32 @@ export interface components { */ readonly "topic-search-result-item": { readonly name: string; + /** @nullable */ readonly display_name: string | null; + /** @nullable */ readonly short_description: string | null; + /** @nullable */ readonly description: string | null; + /** @nullable */ readonly created_by: string | null; + /** @nullable */ readonly released: string | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; readonly featured: boolean; readonly curated: boolean; readonly score: number; + /** @nullable */ readonly repository_count?: number | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly logo_url?: string | null; readonly text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ readonly related?: readonly { readonly topic_relation?: { readonly id?: number; @@ -34144,6 +35500,7 @@ export interface components { readonly relation_type?: string; }; }[] | null; + /** @nullable */ readonly aliases?: readonly { readonly topic_relation?: { readonly id?: number; @@ -34159,25 +35516,26 @@ export interface components { */ readonly "user-search-result-item": { readonly login: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; + /** @nullable */ readonly gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly followers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url: string; - /** Format: uri */ + /** @format uri */ readonly repos_url: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url: string; readonly type: string; readonly score: number; @@ -34189,21 +35547,33 @@ export interface components { readonly public_gists?: number; readonly followers?: number; readonly following?: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; + /** @nullable */ readonly name?: string | null; + /** @nullable */ readonly bio?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email?: string | null; + /** @nullable */ readonly location?: string | null; readonly site_admin: boolean; + /** @nullable */ readonly hireable?: boolean | null; readonly text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ readonly blog?: string | null; + /** @nullable */ readonly company?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly suspended_at?: string | null; readonly user_view_type?: string; }; @@ -34215,8 +35585,8 @@ export interface components { /** @example octocat */ readonly login: string; /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @@ -34227,25 +35597,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ readonly gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ readonly url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ readonly html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ readonly followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -34255,52 +35628,73 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ readonly starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ readonly subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ readonly organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ readonly repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ readonly events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ readonly received_events_url: string; /** @example User */ readonly type: string; readonly site_admin: boolean; - /** @example monalisa octocat */ + /** + * @nullable + * @example monalisa octocat + */ readonly name: string | null; - /** @example GitHub */ + /** + * @nullable + * @example GitHub + */ readonly company: string | null; - /** @example https://github.com/blog */ + /** + * @nullable + * @example https://github.com/blog + */ readonly blog: string | null; - /** @example San Francisco */ + /** + * @nullable + * @example San Francisco + */ readonly location: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ readonly email: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ readonly notification_email?: string | null; + /** @nullable */ readonly hireable: boolean | null; - /** @example There once was... */ + /** + * @nullable + * @example There once was... + */ readonly bio: string | null; - /** @example monalisa */ + /** + * @nullable + * @example monalisa + */ readonly twitter_username?: string | null; /** @example 2 */ readonly public_repos: number; @@ -34311,13 +35705,13 @@ export interface components { /** @example 0 */ readonly following: number; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ readonly updated_at: string; /** @example 81 */ @@ -34352,13 +35746,13 @@ export interface components { */ readonly name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ readonly updated_at: string; /** @@ -34367,9 +35761,9 @@ export interface components { */ readonly visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/user/secrets/SECRET_NAME/repositories + * @format uri */ readonly selected_repositories_url: string; }; @@ -34395,22 +35789,26 @@ export interface components { */ readonly "codespace-export-details": { /** + * @nullable * @description State of the latest export * @example succeeded | failed | in_progress */ readonly state?: string | null; /** - * Format: date-time + * @nullable * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z + * @format date-time */ readonly completed_at?: string | null; /** + * @nullable * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ readonly branch?: string | null; /** + * @nullable * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ @@ -34426,6 +35824,7 @@ export interface components { */ readonly export_url?: string; /** + * @nullable * @description Web url for the exported branch * @example https://github.com/octocat/hello-world/tree/:branch */ @@ -34437,8 +35836,8 @@ export interface components { */ readonly "codespace-with-full-repository": { /** - * Format: int64 * @example 1 + * @format int64 */ readonly id: number; /** @@ -34447,11 +35846,13 @@ export interface components { */ readonly name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ readonly display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -34461,29 +35862,31 @@ export interface components { readonly repository: components["schemas"]["full-repository"]; readonly machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ readonly devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ readonly prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly last_used_at: string; /** @@ -34493,8 +35896,8 @@ export interface components { */ readonly state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ readonly url: string; /** @description Details about the codespace's git repository. */ @@ -34526,60 +35929,77 @@ export interface components { */ readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ readonly idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ readonly web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ readonly machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ readonly start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ readonly stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ readonly publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ readonly pulls_url: string | null; readonly recent_folders: readonly string[]; readonly runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ readonly allowed_port_privacy_settings?: readonly string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ readonly pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ readonly pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ readonly idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ readonly retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ readonly retention_expires_at?: string | null; }; @@ -34589,15 +36009,18 @@ export interface components { */ readonly email: { /** - * Format: email * @example octocat@github.com + * @format email */ readonly email: string; /** @example true */ readonly primary: boolean; /** @example true */ readonly verified: boolean; - /** @example public */ + /** + * @nullable + * @example public + */ readonly visibility: string | null; }; /** @@ -34606,12 +36029,16 @@ export interface components { */ readonly "gpg-key": { /** - * Format: int64 * @example 3 + * @format int64 */ readonly id: number; - /** @example Octocat's GPG Key */ + /** + * @nullable + * @example Octocat's GPG Key + */ readonly name?: string | null; + /** @nullable */ readonly primary_key_id: number | null; /** @example 3262EFF25BA0D270 */ readonly key_id: string; @@ -34648,7 +36075,7 @@ export interface components { * ] */ readonly subkeys: readonly { - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly primary_key_id?: number; readonly key_id?: string; @@ -34663,7 +36090,9 @@ export interface components { readonly can_encrypt_storage?: boolean; readonly can_certify?: boolean; readonly created_at?: string; + /** @nullable */ readonly expires_at?: string | null; + /** @nullable */ readonly raw_key?: string | null; readonly revoked?: boolean; }[]; @@ -34674,14 +36103,18 @@ export interface components { /** @example true */ readonly can_certify: boolean; /** - * Format: date-time * @example 2016-03-24T11:31:04-06:00 + * @format date-time */ readonly created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly expires_at: string | null; /** @example true */ readonly revoked: boolean; + /** @nullable */ readonly raw_key: string | null; }; /** @@ -34690,26 +36123,32 @@ export interface components { */ readonly key: { readonly key: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly url: string; readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly verified: boolean; readonly read_only: boolean; }; /** Marketplace Account */ readonly "marketplace-account": { - /** Format: uri */ + /** @format uri */ readonly url: string; readonly id: number; readonly type: string; readonly node_id?: string; readonly login: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly organization_billing_email?: string | null; }; /** @@ -34720,21 +36159,25 @@ export interface components { /** @example monthly */ readonly billing_cycle: string; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ readonly next_billing_date: string | null; + /** @nullable */ readonly unit_count: number | null; /** @example true */ readonly on_free_trial: boolean; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ readonly free_trial_ends_on: string | null; /** - * Format: date-time + * @nullable * @example 2017-11-02T01:12:12Z + * @format date-time */ readonly updated_at: string | null; readonly account: components["schemas"]["marketplace-account"]; @@ -34758,7 +36201,7 @@ export interface components { readonly key: string; readonly id: number; readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; }; /** @@ -34766,7 +36209,7 @@ export interface components { * @description Starred Repository */ readonly "starred-repository": { - /** Format: date-time */ + /** @format date-time */ readonly starred_at: string; readonly repo: components["schemas"]["repository"]; }; @@ -34795,9 +36238,11 @@ export interface components { readonly inclusionPromise?: { readonly signedEntryTimestamp?: string; }; + /** @nullable */ readonly inclusionProof?: string | null; readonly canonicalizedBody?: string; }[]; + /** @nullable */ readonly timestampVerificationData?: string | null; }; readonly dsseEnvelope?: { @@ -34834,16 +36279,20 @@ export interface components { * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." */ readonly "enterprise-webhooks": { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ readonly description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ readonly website_url?: string | null; /** @@ -34864,16 +36313,18 @@ export interface components { */ readonly slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; }; /** @@ -34907,18 +36358,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ readonly node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ readonly url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ readonly repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ readonly events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -34931,7 +36382,10 @@ export interface components { readonly public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ readonly avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ readonly description: string | null; }; /** @@ -34941,9 +36395,9 @@ export interface components { */ readonly "repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -34972,16 +36426,19 @@ export interface components { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -35003,28 +36460,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -35046,13 +36503,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -35066,30 +36523,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -35097,25 +36554,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -35190,18 +36650,21 @@ export interface components { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -35210,6 +36673,7 @@ export interface components { * @example true */ readonly allow_rebase_merge: boolean; + /** @nullable */ readonly template_repository?: { readonly id?: number; readonly node_id?: string; @@ -35456,7 +36920,7 @@ export interface components { readonly authorized_actors_only: boolean; readonly authorized_dismissal_actors_only: boolean; readonly create_protected?: boolean; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly dismiss_stale_reviews_on_push: boolean; readonly id: number; @@ -35490,24 +36954,34 @@ export interface components { /** @enum {string} */ readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; readonly strict_required_status_checks_policy: boolean; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; }; /** @description A suite of checks performed on the code of a given code change */ readonly "simple-check-suite": { - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ readonly after?: string | null; readonly app?: components["schemas"]["integration"]; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ readonly before?: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ readonly conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at?: string; - /** @example master */ + /** + * @nullable + * @example master + */ readonly head_branch?: string | null; /** * @description The SHA of the head commit that is being checked. @@ -35525,7 +36999,7 @@ export interface components { * @enum {string} */ readonly status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at?: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ readonly url?: string; @@ -35538,11 +37012,13 @@ export interface components { readonly app: components["schemas"]["nullable-integration"]; readonly check_suite: components["schemas"]["simple-check-suite"]; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ readonly completed_at: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ @@ -35573,16 +37049,19 @@ export interface components { readonly node_id: string; readonly output: { readonly annotations_count: number; - /** Format: uri */ + /** @format uri */ readonly annotations_url: string; + /** @nullable */ readonly summary: string | null; + /** @nullable */ readonly text: string | null; + /** @nullable */ readonly title: string | null; }; readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][]; /** - * Format: date-time * @example 2018-05-04T01:14:52Z + * @format date-time */ readonly started_at: string; /** @@ -35604,34 +37083,39 @@ export interface components { readonly webhooks_ref_0: string; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ readonly webhooks_deploy_key: { + /** @nullable */ readonly added_by?: string | null; readonly created_at: string; readonly id: number; readonly key: string; + /** @nullable */ readonly last_used?: string | null; readonly read_only: boolean; readonly title: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly verified: boolean; readonly enabled?: boolean; }; - /** Workflow */ + /** + * Workflow + * @nullable + */ readonly webhooks_workflow: { - /** Format: uri */ + /** @format uri */ readonly badge_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly name: string; readonly node_id: string; readonly path: string; readonly state: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly webhooks_approver: { @@ -35656,92 +37140,102 @@ export interface components { readonly user_view_type?: string; }; readonly webhooks_reviewers: readonly { - /** User */ + /** + * User + * @nullable + */ readonly reviewer?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; /** @enum {string} */ readonly type?: "User"; }[]; readonly webhooks_workflow_job_run: { + /** @nullable */ readonly conclusion: unknown; readonly created_at: string; readonly environment: string; readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: unknown; readonly status: string; readonly updated_at: string; }; - /** User */ + /** + * User + * @nullable + */ readonly webhooks_user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -35754,12 +37248,13 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; readonly body: string; readonly child_comment_count: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly discussion_id: number; readonly html_url: string; readonly id: number; readonly node_id: string; + /** @nullable */ readonly parent_id: unknown; /** Reactions */ readonly reactions?: { @@ -35772,48 +37267,52 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly repository_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -35823,46 +37322,53 @@ export interface components { * @description A Discussion in a repository. */ readonly discussion: { + /** @nullable */ readonly active_lock_reason: string | null; + /** @nullable */ readonly answer_chosen_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly answer_chosen_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly answer_html_url: string | null; /** * AuthorAssociation @@ -35872,7 +37378,7 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; readonly body: string; readonly category: { - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly description: string; readonly emoji: string; @@ -35885,7 +37391,7 @@ export interface components { readonly updated_at: string; }; readonly comments: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly html_url: string; readonly id: number; @@ -35903,7 +37409,7 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly repository_url: string; @@ -35915,6 +37421,7 @@ export interface components { */ readonly state: "open" | "closed" | "locked" | "converting" | "transferring"; /** + * @nullable * @description The reason for the current state * @example resolved * @enum {string|null} @@ -35922,44 +37429,48 @@ export interface components { readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; readonly timeline_url?: string; readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -35979,6 +37490,7 @@ export interface components { readonly html_url: string; readonly id: number; readonly node_id: string; + /** @nullable */ readonly parent_id: number | null; /** Reactions */ readonly reactions: { @@ -35991,47 +37503,51 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly repository_url: string; readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36041,14 +37557,15 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }; @@ -36092,16 +37609,16 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ readonly body: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly node_id: string; readonly performed_via_github_app: components["schemas"]["integration"]; @@ -36116,52 +37633,56 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36178,80 +37699,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly webhooks_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -36261,95 +37790,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -36362,67 +37910,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36501,19 +38064,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -36527,10 +38096,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -36543,54 +38112,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36600,56 +38174,67 @@ export interface components { * @description A collection of related issues and pull requests. */ readonly webhooks_milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -36662,9 +38247,9 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -36672,80 +38257,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly webhooks_issue_2: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -36755,95 +38348,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -36856,67 +38468,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -36995,19 +38622,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -37021,10 +38654,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -37037,93 +38670,102 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** User */ + /** + * User + * @nullable + */ readonly webhooks_user_mannequin: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -37133,11 +38775,14 @@ export interface components { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: string | null; + /** @nullable */ readonly next_billing_date: string | null; readonly on_free_trial: boolean; readonly plan: { @@ -37149,6 +38794,7 @@ export interface components { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -37160,11 +38806,14 @@ export interface components { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: unknown; + /** @nullable */ readonly next_billing_date?: string | null; readonly on_free_trial: boolean; readonly plan: { @@ -37176,6 +38825,7 @@ export interface components { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -37187,25 +38837,32 @@ export interface components { */ readonly webhooks_team: { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -37219,12 +38876,12 @@ export interface components { * @enum {string} */ readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -37234,12 +38891,12 @@ export interface components { readonly privacy?: "open" | "closed" | "secret"; /** @enum {string} */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }; @@ -37260,14 +38917,15 @@ export interface components { }; /** * Repository + * @nullable * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ readonly "nullable-repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -37296,16 +38954,19 @@ export interface components { */ readonly private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ readonly html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ readonly description: string | null; readonly fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ readonly url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -37327,28 +38988,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ readonly contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ readonly contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ readonly deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ readonly downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ readonly events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ readonly forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -37370,13 +39031,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ readonly labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ readonly languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ readonly merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -37390,30 +39051,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ readonly ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ readonly stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ readonly statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ readonly subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ readonly subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ readonly tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ readonly teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -37421,25 +39082,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ readonly clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ readonly mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ readonly hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ readonly svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ readonly homepage: string | null; + /** @nullable */ readonly language: string | null; /** @example 9 */ readonly forks_count: number; @@ -37514,18 +39178,21 @@ export interface components { */ readonly visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ readonly pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ readonly updated_at: string | null; /** @@ -37534,6 +39201,7 @@ export interface components { * @example true */ readonly allow_rebase_merge: boolean; + /** @nullable */ readonly template_repository?: { readonly id?: number; readonly node_id?: string; @@ -37771,56 +39439,67 @@ export interface components { * @description A collection of related issues and pull requests. */ readonly webhooks_milestone_3: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -37833,9 +39512,9 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -37843,48 +39522,52 @@ export interface components { * @description The membership between the user and the organization. Not present when the action is `member_invited`. */ readonly webhooks_membership: { - /** Format: uri */ + /** @format uri */ readonly organization_url: string; readonly role: string; readonly state: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -37938,9 +39621,15 @@ export interface components { * @enum {string} */ readonly repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ readonly repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ readonly repositories: readonly { readonly full_name: string; /** @description Unique identifier of the repository */ @@ -37959,154 +39648,174 @@ export interface components { readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ readonly token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ readonly token_last_used_at: string | null; }; /** Project Card */ readonly webhooks_project_card: { + /** @nullable */ readonly after_id?: number | null; /** @description Whether or not the card is archived */ readonly archived: boolean; readonly column_id: number; - /** Format: uri */ + /** @format uri */ readonly column_url: string; - /** Format: uri */ + /** @format uri */ readonly content_url?: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; readonly node_id: string; + /** @nullable */ readonly note: string | null; - /** Format: uri */ + /** @format uri */ readonly project_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** Project */ readonly webhooks_project: { - /** @description Body of the project */ + /** + * @nullable + * @description Body of the project + */ readonly body: string | null; - /** Format: uri */ + /** @format uri */ readonly columns_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; /** @description Name of the project */ readonly name: string; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly owner_url: string; /** * @description State of the project; either 'open' or 'closed' * @enum {string} */ readonly state: "open" | "closed"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** Project Column */ readonly webhooks_project_column: { + /** @nullable */ readonly after_id?: number | null; - /** Format: uri */ + /** @format uri */ readonly cards_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The unique identifier of the project column */ readonly id: number; /** @description Name of the project column */ readonly name: string; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly project_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -38119,37 +39828,47 @@ export interface components { readonly owner: components["schemas"]["simple-user"]; readonly creator: components["schemas"]["simple-user"]; readonly title: string; + /** @nullable */ readonly description: string | null; readonly public: boolean; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly updated_at: string; readonly number: number; + /** @nullable */ readonly short_description: string | null; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly deleted_at: string | null; readonly deleted_by: components["schemas"]["nullable-simple-user"]; }; readonly webhooks_project_changes: { readonly archived_at?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly from?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly to?: string | null; }; }; @@ -38171,18 +39890,19 @@ export interface components { readonly content_type: components["schemas"]["projects-v2-item-content-type"]; readonly creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly archived_at: string | null; }; @@ -38193,7 +39913,9 @@ export interface components { readonly "projects-v2-single-select-option": { readonly id: string; readonly name: string; + /** @nullable */ readonly color?: string | null; + /** @nullable */ readonly description?: string | null; }; /** @@ -38203,7 +39925,9 @@ export interface components { readonly "projects-v2-iteration-setting": { readonly id: string; readonly title: string; + /** @nullable */ readonly duration?: number | null; + /** @nullable */ readonly start_date?: string | null; }; /** @@ -38216,28 +39940,32 @@ export interface components { readonly project_node_id?: string; readonly creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ readonly updated_at: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** - * Format: date * @example 2022-04-28 + * @format date */ readonly start_date?: string; /** - * Format: date * @example 2022-04-28 + * @format date */ readonly target_date?: string; /** + * @nullable * @description Body of the status update * @example The project is off to a great start! */ @@ -38299,120 +40027,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -38423,48 +40159,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -38505,32 +40252,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -38540,28 +40287,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -38589,37 +40337,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -38640,55 +40396,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -38702,11 +40465,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -38729,26 +40494,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -38763,60 +40528,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -38851,32 +40624,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -38886,28 +40659,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -38935,37 +40709,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -38986,55 +40768,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -39048,11 +40837,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -39075,26 +40866,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -39109,168 +40900,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -39283,73 +41101,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -39358,12 +41185,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -39371,36 +41198,43 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -39409,12 +41243,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -39422,69 +41256,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -39497,17 +41335,17 @@ export interface components { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -39521,20 +41359,23 @@ export interface components { readonly body: string; /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The diff of the line that the comment refers to. */ readonly diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ readonly html_url: string; /** @description The ID of the pull request review comment. */ readonly id: number; /** @description The comment ID to reply to. */ readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the pull request review comment. */ readonly node_id: string; @@ -39544,17 +41385,26 @@ export interface components { readonly original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ readonly path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ readonly pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ readonly pull_request_url: string; /** Reactions */ @@ -39568,7 +41418,7 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -39576,9 +41426,13 @@ export interface components { * @enum {string} */ readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -39589,49 +41443,53 @@ export interface components { * @enum {string} */ readonly subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -39641,12 +41499,12 @@ export interface components { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -39656,60 +41514,71 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ readonly body: string | null; /** @description A commit SHA for the review. */ readonly commit_id: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the review */ readonly id: number; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly pull_request_url: string; readonly state: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly submitted_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly webhooks_nullable_string: string | null; /** * Release @@ -39717,13 +41586,14 @@ export interface components { */ readonly webhooks_release: { readonly assets: readonly { - /** Format: uri */ + /** @format uri */ readonly browser_download_url: string; readonly content_type: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly download_count: number; readonly id: number; + /** @nullable */ readonly label: string | null; /** @description The file name of the asset. */ readonly name: string; @@ -39734,103 +41604,119 @@ export interface components { * @enum {string} */ readonly state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly uploader?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; - /** Format: uri */ + /** @format uri */ readonly assets_url: string; - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: uri */ + /** @format uri */ readonly discussion_url?: string; /** @description Whether the release is a draft or published */ readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ readonly prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly published_at: string | null; /** Reactions */ readonly reactions?: { @@ -39843,20 +41729,26 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @description The name of the tag. */ readonly tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ readonly target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ readonly upload_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly zipball_url: string | null; }; /** @@ -39865,13 +41757,14 @@ export interface components { */ readonly webhooks_release_1: { readonly assets: readonly ({ - /** Format: uri */ + /** @format uri */ readonly browser_download_url: string; readonly content_type: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly download_count: number; readonly id: number; + /** @nullable */ readonly label: string | null; /** @description The file name of the asset. */ readonly name: string; @@ -39882,103 +41775,119 @@ export interface components { * @enum {string} */ readonly state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly uploader?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ readonly assets_url: string; - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: uri */ + /** @format uri */ readonly discussion_url?: string; /** @description Whether the release is a draft or published */ readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ readonly prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly published_at: string | null; /** Reactions */ readonly reactions?: { @@ -39991,20 +41900,26 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @description The name of the tag. */ readonly tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ readonly target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ readonly upload_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly zipball_url: string | null; }; /** @@ -40017,48 +41932,55 @@ export interface components { readonly created_at: string; readonly dismiss_reason?: string; readonly dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ readonly dismisser?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_reference: string | null; readonly fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ readonly fixed_at?: string; readonly fixed_in?: string; readonly ghsa_id: string; @@ -40070,6 +41992,7 @@ export interface components { readonly state: "open"; }; /** + * @nullable * @description The reason for resolving the alert. * @enum {string|null} */ @@ -40081,18 +42004,22 @@ export interface components { readonly url?: components["schemas"]["alert-url"]; readonly html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ readonly locations_url?: string; readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly resolved_at?: string | null; readonly resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ readonly resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; @@ -40106,33 +42033,51 @@ export interface components { * @enum {string} */ readonly validity?: "active" | "inactive" | "unknown"; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ readonly push_protection_bypassed?: boolean | null; readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly push_protection_bypassed_at?: string | null; readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ readonly push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ readonly push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ readonly push_protection_bypass_request_html_url?: string | null; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ readonly publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or business. + */ readonly multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ readonly webhooks_security_advisory: { readonly cvss: { readonly score: number; + /** @nullable */ readonly vector_string: string | null; }; readonly cvss_severities?: components["schemas"]["cvss-severities"]; @@ -40148,13 +42093,14 @@ export interface components { }[]; readonly published_at: string; readonly references: readonly { - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly severity: string; readonly summary: string; readonly updated_at: string; readonly vulnerabilities: readonly { + /** @nullable */ readonly first_patched_version: { readonly identifier: string; } | null; @@ -40165,6 +42111,7 @@ export interface components { readonly severity: string; readonly vulnerable_version_range: string; }[]; + /** @nullable */ readonly withdrawn_at: string | null; }; readonly webhooks_sponsorship: { @@ -40192,79 +42139,87 @@ export interface components { }; readonly node_id: string; readonly privacy_level: string; - /** User */ + /** + * User + * @nullable + */ readonly sponsor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** User */ + /** + * User + * @nullable + */ readonly sponsorable: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -40311,25 +42266,32 @@ export interface components { */ readonly webhooks_team_1: { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -40343,12 +42305,12 @@ export interface components { * @enum {string} */ readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -40361,12 +42323,12 @@ export interface components { * @enum {string} */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }; @@ -40419,15 +42381,18 @@ export interface components { /** @description If the action was `edited`, the changes to the rule. */ readonly changes?: { readonly admin_enforced?: { + /** @nullable */ readonly from: boolean | null; }; readonly authorized_actor_names?: { readonly from: readonly string[]; }; readonly authorized_actors_only?: { + /** @nullable */ readonly from: boolean | null; }; readonly authorized_dismissal_actors_only?: { + /** @nullable */ readonly from: boolean | null; }; readonly linear_history_requirement_enforcement_level?: { @@ -40439,6 +42404,7 @@ export interface components { readonly from: "off" | "non_admins" | "everyone"; }; readonly lock_allows_fork_sync?: { + /** @nullable */ readonly from: boolean | null; }; readonly pull_request_reviews_enforcement_level?: { @@ -40446,6 +42412,7 @@ export interface components { readonly from: "off" | "non_admins" | "everyone"; }; readonly require_last_push_approval?: { + /** @nullable */ readonly from: boolean | null; }; readonly required_status_checks?: { @@ -40546,63 +42513,81 @@ export interface components { readonly action: "completed"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ readonly check_suite: { + /** @nullable */ readonly after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; - /** @description The client ID of the GitHub app */ + /** + * @nullable + * @description The client ID of the GitHub app + */ readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -40681,20 +42666,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; }; + /** @nullable */ readonly before: string | null; - /** Format: uri */ + /** @format uri */ readonly check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -40703,9 +42696,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -40716,9 +42712,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -40742,7 +42741,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -40753,28 +42752,29 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly rerequestable?: boolean; readonly runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ readonly url: string; }; @@ -40790,63 +42790,81 @@ export interface components { readonly action: "requested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ readonly check_suite: { + /** @nullable */ readonly after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; - /** @description Client ID of the GitHub app */ + /** + * @nullable + * @description Client ID of the GitHub app + */ readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -40925,20 +42943,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; }; + /** @nullable */ readonly before: string | null; - /** Format: uri */ + /** @format uri */ readonly check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -40947,9 +42973,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -40960,9 +42989,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -40986,7 +43018,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -40997,28 +43029,29 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly rerequestable?: boolean; readonly runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ readonly url: string; }; @@ -41034,63 +43067,81 @@ export interface components { readonly action: "rerequested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ readonly check_suite: { + /** @nullable */ readonly after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; - /** @description The Client ID for the GitHub app */ + /** + * @nullable + * @description The Client ID for the GitHub app + */ readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -41169,20 +43220,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; }; + /** @nullable */ readonly before: string | null; - /** Format: uri */ + /** @format uri */ readonly check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -41191,9 +43250,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -41204,9 +43266,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -41230,7 +43295,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -41241,28 +43306,29 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly rerequestable?: boolean; readonly runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ readonly url: string; }; @@ -41279,67 +43345,79 @@ export interface components { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly dismissed_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41375,12 +43453,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41388,10 +43468,13 @@ export interface components { readonly tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41409,67 +43492,78 @@ export interface components { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ readonly dismissed_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41503,17 +43597,23 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ readonly description: string; readonly full_description?: string; + /** @nullable */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ readonly tags?: readonly string[] | null; }; /** @@ -41522,13 +43622,17 @@ export interface components { */ readonly state: "dismissed" | "fixed"; readonly tool: { + /** @nullable */ readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41546,25 +43650,39 @@ export interface components { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time + * @nullable * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly dismissed_at: unknown; + /** @nullable */ readonly dismissed_by: unknown; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ readonly dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; readonly instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41598,33 +43716,46 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ readonly description: string; readonly full_description?: string; + /** @nullable */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ readonly tags?: readonly string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ readonly state: "open" | "dismissed" | null; + /** @nullable */ readonly tool: { + /** @nullable */ readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; } | null; + /** @nullable */ readonly updated_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41642,69 +43773,81 @@ export interface components { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly dismissed_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Format: uri */ + /** @format uri */ readonly instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41738,32 +43881,43 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ readonly description: string; readonly full_description?: string; + /** @nullable */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ readonly tags?: readonly string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ readonly state: "fixed" | null; readonly tool: { + /** @nullable */ readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41778,27 +43932,43 @@ export interface components { readonly "webhook-code-scanning-alert-reopened": { /** @enum {string} */ readonly action: "reopened"; - /** @description The code scanning alert involved in the event. */ + /** + * @nullable + * @description The code scanning alert involved in the event. + */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly dismissed_at: string | null; + /** @nullable */ readonly dismissed_by: Record | null; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ readonly dismissed_reason: string | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41832,40 +44002,57 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ readonly description: string; readonly full_description?: string; + /** @nullable */ readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ readonly help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; readonly name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ readonly tags?: readonly string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ readonly state: "open" | "dismissed" | "fixed" | null; readonly tool: { + /** @nullable */ readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ readonly commit_oid: string | null; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ readonly ref: string | null; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; @@ -41877,24 +44064,37 @@ export interface components { /** @description The code scanning alert involved in the event. */ readonly alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ readonly created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly dismissed_at: unknown; + /** @nullable */ readonly dismissed_by: unknown; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ readonly dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ readonly fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ readonly html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ readonly most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ readonly analysis_key: string; @@ -41930,12 +44130,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ readonly id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ readonly severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41943,10 +44145,13 @@ export interface components { readonly tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ readonly version: string | null; }; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41977,17 +44182,26 @@ export interface components { /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description The ID of the commit comment. */ readonly id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the commit comment. */ readonly node_id: string; - /** @description The relative path of the file to which the comment applies. */ + /** + * @nullable + * @description The relative path of the file to which the comment applies. + */ readonly path: string | null; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; /** Reactions */ readonly reactions?: { @@ -42000,48 +44214,52 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -42054,7 +44272,10 @@ export interface components { }; /** create event */ readonly "webhook-create": { - /** @description The repository's current description. */ + /** + * @nullable + * @description The repository's current description. + */ readonly description: string | null; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; @@ -42242,44 +44463,49 @@ export interface components { */ readonly deployment: { readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; readonly environment: string; readonly id: number; @@ -42288,58 +44514,73 @@ export interface components { readonly payload: Record | string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -42418,20 +44659,23 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly production_environment?: boolean; readonly ref: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly task: string; readonly transient_environment?: boolean; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -42440,43 +44684,50 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -42485,13 +44736,17 @@ export interface components { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly display_title: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: unknown; readonly head_repository?: { readonly archive_url?: string; @@ -42505,6 +44760,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: unknown; readonly downloads_url?: string; readonly events_url?: string; @@ -42561,7 +44817,7 @@ export interface components { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -42569,6 +44825,7 @@ export interface components { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: unknown; readonly pull_requests: readonly { readonly base: { @@ -42577,7 +44834,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -42588,16 +44845,17 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -42615,6 +44873,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: unknown; readonly downloads_url?: string; readonly events_url?: string; @@ -42673,51 +44932,55 @@ export interface components { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -42732,8 +44995,8 @@ export interface components { /** @description The event that triggered the deployment protection rule. */ readonly event?: string; /** - * Format: uri * @description The URL to review the deployment protection rule. + * @format uri */ readonly deployment_callback_url?: string; readonly deployment?: components["schemas"]["deployment"]; @@ -42757,52 +45020,61 @@ export interface components { readonly since: string; readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; readonly workflow_job_runs?: readonly { + /** @nullable */ readonly conclusion?: unknown; readonly created_at?: string; readonly environment?: string; readonly html_url?: string; readonly id?: number; + /** @nullable */ readonly name?: string | null; readonly status?: string; readonly updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -42811,13 +45083,17 @@ export interface components { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly display_title: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: Record | null; readonly head_repository?: { readonly archive_url?: string; @@ -42831,6 +45107,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -42888,7 +45165,7 @@ export interface components { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -42896,6 +45173,7 @@ export interface components { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: string | null; readonly pull_requests: readonly { readonly base: { @@ -42904,7 +45182,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -42915,16 +45193,17 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -42942,6 +45221,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43001,51 +45281,55 @@ export interface components { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -43065,52 +45349,61 @@ export interface components { readonly since: string; readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; readonly workflow_job_runs?: readonly { + /** @nullable */ readonly conclusion?: string | null; readonly created_at?: string; readonly environment?: string; readonly html_url?: string; readonly id?: number; + /** @nullable */ readonly name?: string | null; readonly status?: string; readonly updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -43119,12 +45412,16 @@ export interface components { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: Record | null; readonly head_repository?: { readonly archive_url?: string; @@ -43138,6 +45435,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43195,7 +45493,7 @@ export interface components { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -43203,6 +45501,7 @@ export interface components { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: string | null; readonly pull_requests: readonly { readonly base: { @@ -43211,7 +45510,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -43222,16 +45521,17 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -43249,6 +45549,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43308,51 +45609,55 @@ export interface components { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -43369,41 +45674,45 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly requestor: components["schemas"]["webhooks_user"]; readonly reviewers: readonly { - /** User */ + /** + * User + * @nullable + */ readonly reviewer?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login?: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -43413,52 +45722,61 @@ export interface components { readonly sender: components["schemas"]["simple-user"]; readonly since: string; readonly workflow_job_run: { + /** @nullable */ readonly conclusion: unknown; readonly created_at: string; readonly environment: string; readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly status: string; readonly updated_at: string; }; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -43467,12 +45785,16 @@ export interface components { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: Record | null; readonly head_repository?: { readonly archive_url?: string; @@ -43486,6 +45808,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43543,7 +45866,7 @@ export interface components { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -43551,6 +45874,7 @@ export interface components { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: string | null; readonly pull_requests: readonly { readonly base: { @@ -43559,7 +45883,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -43570,16 +45894,17 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -43597,6 +45922,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly downloads_url?: string; readonly events_url?: string; @@ -43656,51 +45982,55 @@ export interface components { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -43711,34 +46041,39 @@ export interface components { readonly "webhook-deployment-status-created": { /** @enum {string} */ readonly action: "created"; + /** @nullable */ readonly check_run?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly completed_at: string | null; /** + * @nullable * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ + /** @format uri */ readonly details_url: string; readonly external_id: string; /** @description The SHA of the commit that is being checked. */ readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description The id of the check. */ readonly id: number; /** @description The name of the check run. */ readonly name: string; readonly node_id: string; - /** Format: date-time */ + /** @format date-time */ readonly started_at: string; /** * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; /** @@ -43747,104 +46082,125 @@ export interface components { */ readonly deployment: { readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; readonly environment: string; readonly id: number; readonly node_id: string; readonly original_environment: string; + /** @nullable */ readonly payload: (string | Record) | null; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -43923,128 +46279,150 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly production_environment?: boolean; readonly ref: string; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly task: string; readonly transient_environment?: boolean; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ readonly deployment_status: { readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly deployment_url: string; /** @description The optional human-readable description added to the status. */ readonly description: string; readonly environment: string; - /** Format: uri */ + /** @format uri */ readonly environment_url?: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly log_url?: string; readonly node_id: string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -44123,17 +46501,20 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ readonly state: string; /** @description The optional link added to the status. */ readonly target_url: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -44142,43 +46523,50 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow?: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ readonly workflow_run?: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -44187,13 +46575,17 @@ export interface components { readonly check_suite_id: number; readonly check_suite_node_id: string; readonly check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly display_title: string; readonly event: string; readonly head_branch: string; + /** @nullable */ readonly head_commit?: unknown; readonly head_repository?: { readonly archive_url?: string; @@ -44207,6 +46599,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: unknown; readonly downloads_url?: string; readonly events_url?: string; @@ -44263,7 +46656,7 @@ export interface components { readonly url?: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly jobs_url?: string; @@ -44271,6 +46664,7 @@ export interface components { readonly name: string; readonly node_id: string; readonly path: string; + /** @nullable */ readonly previous_attempt_url?: unknown; readonly pull_requests: readonly { readonly base: { @@ -44279,7 +46673,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -44290,16 +46684,17 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -44317,6 +46712,7 @@ export interface components { readonly contents_url?: string; readonly contributors_url?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: unknown; readonly downloads_url?: string; readonly events_url?: string; @@ -44375,51 +46771,55 @@ export interface components { readonly rerun_url?: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; readonly workflow_url?: string; @@ -44444,7 +46844,7 @@ export interface components { readonly changes: { readonly category: { readonly from: { - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly description: string; readonly emoji: string; @@ -44693,32 +47093,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -44728,28 +47128,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -44772,89 +47173,104 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -44868,36 +47284,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -44922,6 +47340,7 @@ export interface components { readonly created_at?: string; readonly default_branch?: string; readonly deployments_url?: string; + /** @nullable */ readonly description?: string | null; readonly disabled?: boolean; readonly downloads_url?: string; @@ -44941,6 +47360,7 @@ export interface components { readonly has_pages?: boolean; readonly has_projects?: boolean; readonly has_wiki?: boolean; + /** @nullable */ readonly homepage?: string | null; readonly hooks_url?: string; readonly html_url?: string; @@ -44951,11 +47371,14 @@ export interface components { readonly issues_url?: string; readonly keys_url?: string; readonly labels_url?: string; + /** @nullable */ readonly language?: unknown; readonly languages_url?: string; + /** @nullable */ readonly license?: Record | null; readonly merges_url?: string; readonly milestones_url?: string; + /** @nullable */ readonly mirror_url?: unknown; readonly name?: string; readonly node_id?: string; @@ -45029,14 +47452,15 @@ export interface components { */ readonly action: "created" | "edited"; /** - * Format: uri * @description Points to the HTML wiki page. + * @format uri */ readonly html_url: string; /** @description The name of the page. */ readonly page_name: string; /** @description The latest commit SHA of the page. */ readonly sha: string; + /** @nullable */ readonly summary: string | null; /** @description The current page title. */ readonly title: string; @@ -45065,6 +47489,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ readonly requester?: unknown; readonly sender: components["schemas"]["simple-user"]; }; @@ -45077,6 +47502,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ readonly requester?: unknown; readonly sender: components["schemas"]["simple-user"]; }; @@ -45137,14 +47563,17 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ readonly requester?: unknown; readonly sender: components["schemas"]["simple-user"]; }; readonly "webhook-installation-target-renamed": { readonly account: { + /** @nullable */ readonly archived_at?: string | null; readonly avatar_url: string; readonly created_at?: string; + /** @nullable */ readonly description?: unknown; readonly events_url?: string; readonly followers?: number; @@ -45177,6 +47606,7 @@ export interface components { readonly type?: string; readonly updated_at?: string; readonly url?: string; + /** @nullable */ readonly website_url?: unknown; readonly user_view_type?: string; }; @@ -45206,6 +47636,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ readonly requester?: unknown; readonly sender: components["schemas"]["simple-user"]; }; @@ -45226,16 +47657,16 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ readonly body: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly node_id: string; readonly performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -45250,52 +47681,56 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -45304,80 +47739,88 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -45387,95 +47830,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -45488,67 +47950,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -45627,19 +48104,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -45653,10 +48136,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -45669,100 +48152,112 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; } & { + /** @nullable */ readonly active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees?: readonly (Record | null)[]; readonly author_association?: string; + /** @nullable */ readonly body?: string | null; + /** @nullable */ readonly closed_at?: string | null; readonly comments?: number; readonly comments_url?: string; @@ -45774,22 +48269,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly labels_url?: string; readonly locked: boolean; + /** @nullable */ readonly milestone?: Record | null; readonly node_id?: string; readonly number?: number; + /** @nullable */ readonly performed_via_github_app?: Record | null; readonly reactions?: { readonly "+1"?: number; @@ -45821,7 +48319,7 @@ export interface components { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -45848,80 +48346,88 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -45931,95 +48437,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -46032,67 +48557,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -46171,19 +48711,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -46197,10 +48743,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -46213,100 +48759,112 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; } & { + /** @nullable */ readonly active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees?: readonly (Record | null)[]; readonly author_association?: string; + /** @nullable */ readonly body?: string | null; + /** @nullable */ readonly closed_at?: string | null; readonly comments?: number; readonly comments_url?: string; @@ -46318,22 +48876,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly labels_url?: string; readonly locked: boolean; + /** @nullable */ readonly milestone?: Record | null; readonly node_id?: string; readonly number?: number; + /** @nullable */ readonly performed_via_github_app?: Record | null; readonly reactions?: { readonly "+1"?: number; @@ -46365,7 +48926,7 @@ export interface components { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -46394,80 +48955,88 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -46477,95 +49046,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -46578,67 +49166,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -46717,19 +49320,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -46743,10 +49352,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -46759,100 +49368,112 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; } & { + /** @nullable */ readonly active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees?: readonly (Record | null)[]; readonly author_association?: string; + /** @nullable */ readonly body?: string | null; + /** @nullable */ readonly closed_at?: string | null; readonly comments?: number; readonly comments_url?: string; @@ -46864,22 +49485,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly labels_url?: string; readonly locked: boolean; + /** @nullable */ readonly milestone?: Record | null; readonly node_id?: string; readonly number?: number; + /** @nullable */ readonly performed_via_github_app?: Record | null; readonly reactions?: { readonly "+1"?: number; @@ -46911,7 +49535,7 @@ export interface components { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -46955,80 +49579,88 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -47038,95 +49670,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -47139,67 +49790,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -47278,19 +49944,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -47304,10 +49976,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -47320,63 +49992,72 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; } & { + /** @nullable */ readonly active_lock_reason?: string | null; + /** @nullable */ readonly assignee?: Record | null; readonly assignees?: readonly (Record | null)[]; readonly author_association?: string; + /** @nullable */ readonly body?: string | null; + /** @nullable */ readonly closed_at: string | null; readonly comments?: number; readonly comments_url?: string; @@ -47387,9 +50068,11 @@ export interface components { readonly labels?: readonly (Record | null)[]; readonly labels_url?: string; readonly locked?: boolean; + /** @nullable */ readonly milestone?: Record | null; readonly node_id?: string; readonly number?: number; + /** @nullable */ readonly performed_via_github_app?: Record | null; readonly reactions?: { readonly "+1"?: number; @@ -47418,7 +50101,7 @@ export interface components { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -47448,80 +50131,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -47530,95 +50221,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -47631,67 +50341,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -47770,19 +50495,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -47796,10 +50527,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -47812,54 +50543,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -47879,79 +50615,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -47960,95 +50704,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -48061,67 +50824,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -48200,19 +50978,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -48226,10 +51010,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -48242,54 +51026,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -48321,80 +51110,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -48403,95 +51200,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -48504,67 +51320,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -48643,19 +51474,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -48669,10 +51506,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -48685,54 +51522,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -48753,80 +51595,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -48835,95 +51685,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -48936,67 +51805,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49075,19 +51959,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -49101,10 +51991,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -49117,54 +52007,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49185,80 +52080,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -49268,96 +52171,115 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; /** @enum {boolean} */ readonly locked: true; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -49370,67 +52292,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49509,19 +52446,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -49535,10 +52478,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -49551,54 +52494,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49618,79 +52566,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -49699,95 +52655,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -49800,67 +52775,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -49939,19 +52929,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -49965,10 +52961,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -49981,54 +52977,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -50045,83 +53046,92 @@ export interface components { readonly changes?: { /** * Issue + * @nullable * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly old_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -50131,95 +53141,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -50232,67 +53261,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -50371,19 +53415,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -50397,10 +53447,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -50413,54 +53463,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -50493,32 +53548,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -50532,28 +53587,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** @description Whether the repository has discussions enabled. */ readonly has_discussions?: boolean; @@ -50578,89 +53634,104 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -50674,36 +53745,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -50720,80 +53793,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -50803,95 +53884,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -50904,67 +54004,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51043,19 +54158,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -51069,10 +54190,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -51085,54 +54206,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51163,79 +54289,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -51244,95 +54378,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -51345,67 +54498,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51484,19 +54652,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -51510,10 +54684,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -51526,54 +54700,59 @@ export interface components { * @enum {string} */ readonly state: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51592,80 +54771,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly new_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -51675,95 +54862,114 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; readonly locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -51776,67 +54982,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -51915,19 +55136,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -51941,10 +55168,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -51957,54 +55184,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -52037,32 +55269,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -52076,28 +55308,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -52125,89 +55358,104 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -52221,36 +55469,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -52305,80 +55555,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -52388,96 +55646,115 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; /** @enum {boolean} */ readonly locked: false; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -52490,67 +55767,82 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ readonly performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; /** @description The list of events for the GitHub app */ readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_url: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ readonly id: number | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -52629,19 +55921,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ readonly slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly updated_at: string | null; } | null; readonly pull_request?: { - /** Format: uri */ + /** @format uri */ readonly diff_url?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at?: string | null; - /** Format: uri */ + /** @format uri */ readonly patch_url?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** Reactions */ @@ -52655,10 +55953,10 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly repository_url: string; /** Sub-issues Summary */ readonly sub_issues_summary?: { @@ -52671,54 +55969,59 @@ export interface components { * @enum {string} */ readonly state?: "open" | "closed"; + /** @nullable */ readonly state_reason?: string | null; - /** Format: uri */ + /** @format uri */ readonly timeline_url?: string; /** @description Title of the issue */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -52814,12 +56117,16 @@ export interface components { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: string | null; + /** @nullable */ readonly next_billing_date?: string | null; + /** @nullable */ readonly on_free_trial: boolean | null; readonly plan: { readonly bullets: readonly string[]; @@ -52830,6 +56137,7 @@ export interface components { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -52853,11 +56161,14 @@ export interface components { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: string | null; + /** @nullable */ readonly next_billing_date?: string | null; readonly on_free_trial: boolean; readonly plan: { @@ -52869,6 +56180,7 @@ export interface components { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -52890,11 +56202,14 @@ export interface components { readonly id: number; readonly login: string; readonly node_id: string; + /** @nullable */ readonly organization_billing_email: string | null; readonly type: string; }; readonly billing_cycle: string; + /** @nullable */ readonly free_trial_ends_on: unknown; + /** @nullable */ readonly next_billing_date: string | null; readonly on_free_trial: boolean; readonly plan: { @@ -52906,6 +56221,7 @@ export interface components { readonly name: string; /** @enum {string} */ readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ readonly unit_name: string | null; readonly yearly_price_in_cents: number; }; @@ -52967,7 +56283,9 @@ export interface components { readonly from: string; }; readonly permission?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; }; @@ -53003,41 +56321,45 @@ export interface components { * @enum {string} */ readonly scope: "team"; - /** User */ + /** + * User + * @nullable + */ readonly sender: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -53057,41 +56379,45 @@ export interface components { * @enum {string} */ readonly scope: "team" | "organization"; - /** User */ + /** + * User + * @nullable + */ readonly sender: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -53133,7 +56459,7 @@ export interface components { readonly content_type: "json" | "form"; readonly insecure_ssl: string; readonly secret?: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly created_at: string; @@ -53272,53 +56598,63 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ readonly invitation: { - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; + /** @nullable */ readonly email: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly failed_at: string | null; + /** @nullable */ readonly failed_reason: string | null; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly invitation_teams_url: string; - /** User */ + /** + * User + * @nullable + */ readonly inviter: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly login: string | null; readonly node_id: string; readonly role: string; @@ -53385,96 +56721,110 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ readonly package: { + /** @nullable */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; readonly ecosystem: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly name: string; readonly namespace: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly package_type: string; + /** @nullable */ readonly package_version: { - /** User */ + /** + * User + * @nullable + */ readonly author?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly body?: string | Record; readonly body_html?: string; + /** @nullable */ readonly container_metadata?: { + /** @nullable */ readonly labels?: Record | null; + /** @nullable */ readonly manifest?: Record | null; readonly tag?: { readonly digest?: string; @@ -53487,7 +56837,7 @@ export interface components { readonly tags?: readonly string[]; }[]; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly installation_command: string; @@ -53496,22 +56846,27 @@ export interface components { readonly [key: string]: unknown; }[]; readonly name: string; + /** @nullable */ readonly npm_metadata?: { readonly name?: string; readonly version?: string; readonly npm_user?: string; + /** @nullable */ readonly author?: Record | null; + /** @nullable */ readonly bugs?: Record | null; readonly dependencies?: Record; readonly dev_dependencies?: Record; readonly peer_dependencies?: Record; readonly optional_dependencies?: Record; readonly description?: string; + /** @nullable */ readonly dist?: Record | null; readonly git_head?: string; readonly homepage?: string; readonly license?: string; readonly main?: string; + /** @nullable */ readonly repository?: Record | null; readonly scripts?: Record; readonly id?: string; @@ -53525,6 +56880,7 @@ export interface components { readonly files?: readonly string[]; readonly bin?: Record; readonly man?: Record; + /** @nullable */ readonly directories?: Record | null; readonly os?: readonly string[]; readonly cpu?: readonly string[]; @@ -53535,6 +56891,7 @@ export interface components { readonly published_via_actions?: boolean; readonly deleted_by_id?: number; } | null; + /** @nullable */ readonly nuget_metadata?: readonly { readonly id?: number | string; readonly name?: string; @@ -53548,69 +56905,78 @@ export interface components { readonly package_files: readonly { readonly content_type: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly download_url: string; readonly id: number; + /** @nullable */ readonly md5: string | null; readonly name: string; + /** @nullable */ readonly sha1: string | null; + /** @nullable */ readonly sha256: string | null; readonly size: number; + /** @nullable */ readonly state: string | null; readonly updated_at: string; }[]; readonly package_url?: string; readonly prerelease?: boolean; readonly release?: { - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly created_at: string; readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly prerelease: boolean; readonly published_at: string; readonly tag_name: string; readonly target_commitish: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; @@ -53622,15 +56988,17 @@ export interface components { readonly updated_at?: string; readonly version: string; } | null; + /** @nullable */ readonly registry: { - /** Format: uri */ + /** @format uri */ readonly about_url: string; readonly name: string; readonly type: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly vendor: string; } | null; + /** @nullable */ readonly updated_at: string | null; }; readonly repository?: components["schemas"]["repository-webhooks"]; @@ -53646,88 +57014,97 @@ export interface components { /** @description Information about the package. */ readonly package: { readonly created_at: string; + /** @nullable */ readonly description: string | null; readonly ecosystem: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly name: string; readonly namespace: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly package_type: string; readonly package_version: { - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -53739,7 +57116,7 @@ export interface components { readonly tags?: readonly string[]; }[]; readonly draft?: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly installation_command: string; @@ -53751,11 +57128,13 @@ export interface components { readonly package_files: readonly { readonly content_type: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly download_url: string; readonly id: number; + /** @nullable */ readonly md5: string | null; readonly name: string; + /** @nullable */ readonly sha1: string | null; readonly sha256: string; readonly size: number; @@ -53765,47 +57144,51 @@ export interface components { readonly package_url?: string; readonly prerelease?: boolean; readonly release?: { - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly created_at: string; readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly name: string; @@ -53813,11 +57196,11 @@ export interface components { readonly published_at: string; readonly tag_name: string; readonly target_commitish: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; - /** Format: uri */ + /** @format uri */ readonly source_url?: string; readonly summary: string; readonly tag_name?: string; @@ -53826,12 +57209,13 @@ export interface components { readonly updated_at: string; readonly version: string; }; + /** @nullable */ readonly registry: { - /** Format: uri */ + /** @format uri */ readonly about_url: string; readonly name: string; readonly type: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly vendor: string; } | null; @@ -53844,53 +57228,59 @@ export interface components { readonly "webhook-page-build": { /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ readonly build: { + /** @nullable */ readonly commit: string | null; readonly created_at: string; readonly duration: number; readonly error: { + /** @nullable */ readonly message: string | null; }; - /** User */ + /** + * User + * @nullable + */ readonly pusher: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly status: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -53956,9 +57346,9 @@ export interface components { readonly secret?: components["schemas"]["webhook-config-secret"]; readonly url?: components["schemas"]["webhook-config-url"]; }; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly deliveries_url?: string; /** @description Determines what events the hook is triggered for. Default: ['push']. */ readonly events: readonly string[]; @@ -53970,14 +57360,14 @@ export interface components { * @enum {string} */ readonly name: "web"; - /** Format: uri */ + /** @format uri */ readonly ping_url?: string; - /** Format: uri */ + /** @format uri */ readonly test_url?: string; readonly type: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; }; /** @description The ID of the webhook that triggered the ping. */ @@ -54029,63 +57419,70 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ readonly project_card: { + /** @nullable */ readonly after_id?: number | null; /** @description Whether or not the card is archived */ readonly archived: boolean; + /** @nullable */ readonly column_id: number | null; - /** Format: uri */ + /** @format uri */ readonly column_url: string; - /** Format: uri */ + /** @format uri */ readonly content_url?: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; readonly node_id: string; + /** @nullable */ readonly note: string | null; - /** Format: uri */ + /** @format uri */ readonly project_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; @@ -54097,6 +57494,7 @@ export interface components { readonly action: "edited"; readonly changes: { readonly note: { + /** @nullable */ readonly from: string | null; }; }; @@ -54120,70 +57518,78 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_card: { + /** @nullable */ readonly after_id?: number | null; /** @description Whether or not the card is archived */ readonly archived: boolean; readonly column_id: number; - /** Format: uri */ + /** @format uri */ readonly column_url: string; - /** Format: uri */ + /** @format uri */ readonly content_url?: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; readonly node_id: string; + /** @nullable */ readonly note: string | null; - /** Format: uri */ + /** @format uri */ readonly project_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } & { + /** @nullable */ readonly after_id: number | null; readonly archived?: boolean; readonly column_id?: number; readonly column_url?: string; readonly created_at?: string; + /** @nullable */ readonly creator?: { readonly avatar_url?: string; readonly events_url?: string; @@ -54206,6 +57612,7 @@ export interface components { } | null; readonly id?: number; readonly node_id?: string; + /** @nullable */ readonly note?: string | null; readonly project_url?: string; readonly updated_at?: string; @@ -54362,7 +57769,9 @@ export interface components { readonly action: "edited"; readonly changes: { readonly description?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; readonly public?: { @@ -54370,7 +57779,9 @@ export interface components { readonly to?: boolean; }; readonly short_description?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; readonly title?: { @@ -54399,6 +57810,7 @@ export interface components { readonly action: "converted"; readonly changes: { readonly content_type?: { + /** @nullable */ readonly from?: string | null; readonly to?: string; }; @@ -54440,12 +57852,16 @@ export interface components { readonly field_type?: string; readonly field_name?: string; readonly project_number?: number; + /** @nullable */ readonly from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + /** @nullable */ readonly to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; }; } | { readonly body: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; }; @@ -54460,7 +57876,9 @@ export interface components { readonly action: "reordered"; readonly changes: { readonly previous_projects_v2_item_node_id?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; }; @@ -54512,25 +57930,45 @@ export interface components { readonly action: "edited"; readonly changes?: { readonly body?: { + /** @nullable */ readonly from?: string | null; + /** @nullable */ readonly to?: string | null; }; readonly status?: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; readonly start_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ readonly from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ readonly to?: string | null; }; readonly target_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ readonly from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ readonly to?: string | null; }; }; @@ -54561,120 +57999,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -54686,48 +58132,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -54768,32 +58225,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -54803,28 +58260,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -54852,37 +58310,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -54903,55 +58369,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -54965,11 +58438,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -54992,26 +58467,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55026,68 +58501,78 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -55114,32 +58599,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -55149,28 +58634,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -55198,37 +58684,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -55249,55 +58743,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -55311,11 +58812,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -55338,26 +58841,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55372,168 +58875,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -55546,74 +59076,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -55622,12 +59161,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -55635,36 +59174,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -55673,12 +59219,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -55686,69 +59232,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -55769,120 +59319,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -55893,48 +59451,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -55975,32 +59544,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -56010,28 +59579,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -56059,37 +59629,45 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -56110,55 +59688,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -56172,11 +59757,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -56199,26 +59786,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56233,60 +59820,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -56321,32 +59916,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -56356,28 +59951,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -56405,37 +60001,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -56456,55 +60060,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -56518,11 +60129,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -56545,26 +60158,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56579,168 +60192,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -56753,74 +60393,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -56829,12 +60478,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -56842,36 +60491,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -56880,12 +60536,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -56893,69 +60549,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -56977,120 +60637,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -57101,48 +60769,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -57183,32 +60862,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -57218,28 +60897,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -57267,37 +60947,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -57318,55 +61006,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -57380,11 +61075,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -57407,26 +61104,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57441,60 +61138,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -57529,32 +61234,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -57564,28 +61269,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -57613,34 +61319,42 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -57661,55 +61375,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -57723,11 +61444,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -57750,26 +61473,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57784,168 +61507,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -57958,74 +61708,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -58034,12 +61793,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -58047,36 +61806,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -58085,12 +61851,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -58098,69 +61864,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -58218,120 +61988,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -58342,48 +62120,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -58424,32 +62213,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -58459,28 +62248,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -58508,37 +62298,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -58559,55 +62357,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -58621,11 +62426,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -58648,26 +62455,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -58682,60 +62489,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -58770,32 +62585,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -58805,28 +62620,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -58854,37 +62670,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -58905,55 +62729,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -58967,11 +62798,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -58994,26 +62827,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59028,168 +62861,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -59202,74 +63062,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -59278,12 +63147,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -59291,36 +63160,43 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -59329,12 +63205,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -59342,69 +63218,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -59458,120 +63338,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -59582,48 +63470,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -59664,32 +63563,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -59699,28 +63598,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -59748,37 +63648,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -59799,55 +63707,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -59861,11 +63776,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -59888,26 +63805,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59922,60 +63839,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -60010,32 +63935,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -60045,28 +63970,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -60094,37 +64020,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -60145,55 +64079,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -60207,11 +64148,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -60234,26 +64177,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -60268,168 +64211,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -60442,74 +64412,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -60518,12 +64497,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -60531,36 +64510,43 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -60569,12 +64555,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -60582,69 +64568,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -60666,120 +64656,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -60790,48 +64788,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -60872,32 +64881,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -60907,28 +64916,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -60956,37 +64966,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -61007,55 +65025,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -61069,11 +65094,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -61096,26 +65123,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61130,68 +65157,78 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -61218,32 +65255,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -61253,28 +65290,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -61302,37 +65340,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -61353,55 +65399,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -61415,11 +65468,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -61442,26 +65497,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61476,168 +65531,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -61650,74 +65732,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -61726,12 +65817,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -61739,36 +65830,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -61777,12 +65875,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -61790,69 +65888,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -61873,120 +65975,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -61997,48 +66107,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -62079,32 +66200,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -62114,28 +66235,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -62163,37 +66285,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -62214,55 +66344,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -62276,11 +66413,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -62303,26 +66442,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62337,68 +66476,78 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -62425,32 +66574,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -62460,28 +66609,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -62509,37 +66659,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -62560,55 +66718,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -62622,11 +66787,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -62649,26 +66816,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62683,168 +66850,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -62857,74 +67051,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -62933,12 +67136,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -62946,36 +67149,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -62984,12 +67194,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -62997,69 +67207,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -63127,17 +67341,17 @@ export interface components { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -63151,40 +67365,55 @@ export interface components { readonly body: string; /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The diff of the line that the comment refers to. */ readonly diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ readonly html_url: string; /** @description The ID of the pull request review comment. */ readonly id: number; /** @description The comment ID to reply to. */ readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the pull request review comment. */ readonly node_id: string; /** @description The SHA of the original commit to which the comment applies. */ readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ readonly path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ readonly pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ readonly pull_request_url: string; /** Reactions */ @@ -63198,7 +67427,7 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -63206,9 +67435,13 @@ export interface components { * @enum {string} */ readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -63219,49 +67452,53 @@ export interface components { * @enum {string} */ readonly subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -63273,119 +67510,127 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -63396,48 +67641,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -63478,32 +67734,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -63513,28 +67769,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -63562,37 +67819,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -63613,55 +67878,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -63675,11 +67947,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -63702,26 +67976,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -63736,54 +68010,60 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft?: boolean; readonly head: { @@ -63791,6 +68071,7 @@ export interface components { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -63817,32 +68098,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -63852,28 +68133,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -63901,37 +68183,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -63952,55 +68242,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -64014,11 +68311,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -64041,26 +68340,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64075,124 +68374,143 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -64205,72 +68523,80 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -64279,12 +68605,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -64292,36 +68618,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -64330,12 +68663,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -64343,63 +68676,67 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -64419,119 +68756,127 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -64542,48 +68887,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -64624,32 +68980,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -64659,28 +69015,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -64708,37 +69065,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -64759,55 +69124,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -64821,11 +69193,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -64848,26 +69222,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64882,54 +69256,60 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft?: boolean; readonly head: { @@ -64937,6 +69317,7 @@ export interface components { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -64963,32 +69344,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -64998,28 +69379,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -65047,37 +69429,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -65098,55 +69488,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -65160,11 +69557,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -65187,26 +69586,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -65221,124 +69620,143 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -65351,72 +69769,80 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -65425,12 +69851,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -65438,36 +69864,43 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -65476,12 +69909,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -65489,63 +69922,67 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -65566,119 +70003,127 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -65690,48 +70135,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -65772,32 +70228,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -65807,28 +70263,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -65856,37 +70313,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -65907,55 +70372,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -65969,11 +70441,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -65996,26 +70470,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66030,54 +70504,60 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft?: boolean; readonly head: { @@ -66085,6 +70565,7 @@ export interface components { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -66111,32 +70592,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -66146,28 +70627,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -66195,37 +70677,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -66246,55 +70736,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -66308,11 +70805,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -66335,26 +70834,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66369,124 +70868,143 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -66499,72 +71017,80 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -66573,12 +71099,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -66586,36 +71112,43 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -66624,12 +71157,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -66637,64 +71170,68 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; readonly user_view_type?: string; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; }; @@ -66713,119 +71250,127 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -66836,48 +71381,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -66918,32 +71474,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -66953,28 +71509,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -67002,37 +71559,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -67053,55 +71618,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -67115,11 +71687,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -67142,26 +71716,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67176,54 +71750,60 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { @@ -67231,6 +71811,7 @@ export interface components { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -67257,32 +71838,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -67292,28 +71873,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -67341,37 +71923,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -67392,55 +71982,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -67454,11 +72051,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -67481,26 +72080,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67515,124 +72114,143 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -67645,72 +72263,80 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -67719,12 +72345,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -67732,36 +72358,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -67770,12 +72403,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -67783,63 +72416,67 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -67850,12 +72487,12 @@ export interface components { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -67865,57 +72502,64 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ readonly body: string | null; /** @description A commit SHA for the review. */ readonly commit_id: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the review */ readonly id: number; readonly node_id: string; - /** Format: uri */ + /** @format uri */ readonly pull_request_url: string; /** @enum {string} */ readonly state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ + /** @format date-time */ readonly submitted_at: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -67940,119 +72584,127 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -68063,48 +72715,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -68145,32 +72808,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -68180,28 +72843,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -68224,89 +72888,104 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -68320,36 +72999,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -68357,54 +73038,60 @@ export interface components { readonly watchers_count: number; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { @@ -68412,6 +73099,7 @@ export interface components { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -68438,32 +73126,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -68473,28 +73161,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -68517,89 +73206,104 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -68613,36 +73317,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -68650,124 +73356,143 @@ export interface components { readonly watchers_count: number; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -68780,72 +73505,80 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -68854,12 +73587,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -68867,36 +73600,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -68905,12 +73645,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -68918,63 +73658,67 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -68997,120 +73741,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -69122,48 +73874,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -69204,32 +73967,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -69239,28 +74002,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -69288,37 +74052,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -69339,55 +74111,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -69401,11 +74180,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -69421,26 +74202,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69455,60 +74236,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -69543,32 +74332,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -69578,28 +74367,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -69627,37 +74417,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -69678,55 +74476,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -69740,11 +74545,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -69767,26 +74574,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69801,168 +74608,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -69975,74 +74809,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -70051,12 +74894,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -70064,36 +74907,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -70102,12 +74952,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -70115,109 +74965,117 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ readonly requested_reviewer: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -70235,120 +75093,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -70360,48 +75226,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -70442,32 +75319,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -70477,28 +75354,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -70526,37 +75404,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -70577,55 +75463,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -70639,11 +75532,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -70666,26 +75561,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -70700,60 +75595,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -70788,32 +75691,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -70823,28 +75726,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -70872,37 +75776,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -70923,55 +75835,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -70985,11 +75904,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -71012,26 +75933,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71046,168 +75967,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -71220,74 +76168,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -71296,12 +76253,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -71309,36 +76266,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -71347,12 +76311,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -71360,69 +76324,73 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -71434,25 +76402,32 @@ export interface components { */ readonly requested_team: { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -71461,12 +76436,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -71474,12 +76449,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; }; @@ -71499,120 +76474,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -71624,48 +76607,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -71706,32 +76700,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -71741,28 +76735,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -71790,37 +76785,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -71841,55 +76844,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -71903,11 +76913,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -71930,26 +76942,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71964,60 +76976,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -72052,32 +77072,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -72087,28 +77107,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -72136,37 +77157,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -72187,55 +77216,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -72249,11 +77285,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -72276,26 +77314,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -72310,168 +77348,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -72484,74 +77549,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -72560,12 +77634,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -72573,36 +77647,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -72611,12 +77692,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -72624,109 +77705,117 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ readonly requested_reviewer: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -72744,120 +77833,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null)[]; @@ -72869,48 +77966,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -72951,32 +78059,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -72986,28 +78094,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -73035,37 +78144,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -73086,55 +78203,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -73148,11 +78272,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -73175,26 +78301,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73209,60 +78335,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -73297,32 +78431,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -73332,28 +78466,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -73381,37 +78516,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -73432,55 +78575,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -73494,11 +78644,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -73521,26 +78673,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73555,168 +78707,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -73729,74 +78908,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -73805,12 +78993,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -73818,36 +79006,43 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -73856,12 +79051,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -73869,69 +79064,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -73943,25 +79142,32 @@ export interface components { */ readonly requested_team: { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -73970,12 +79176,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -73983,12 +79189,12 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }; @@ -74006,119 +79212,127 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -74129,48 +79343,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -74211,32 +79436,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -74246,28 +79471,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -74295,37 +79521,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -74346,55 +79580,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -74408,11 +79649,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -74435,26 +79678,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74469,61 +79712,69 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -74550,32 +79801,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -74585,28 +79836,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -74634,37 +79886,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -74685,55 +79945,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -74747,11 +80014,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -74774,26 +80043,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74808,124 +80077,143 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -74938,72 +80226,80 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -75012,12 +80308,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -75025,36 +80321,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -75063,12 +80366,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -75076,63 +80379,67 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -75153,119 +80460,127 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -75276,48 +80591,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -75358,32 +80684,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -75393,28 +80719,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -75442,89 +80769,104 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -75538,36 +80880,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -75577,61 +80921,69 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -75658,32 +81010,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -75693,28 +81045,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -75742,89 +81095,104 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -75838,36 +81206,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -75877,124 +81247,143 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -76007,72 +81396,80 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -76081,12 +81478,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -76094,36 +81491,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -76132,12 +81536,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -76145,63 +81549,67 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -76213,17 +81621,17 @@ export interface components { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -76237,40 +81645,55 @@ export interface components { readonly body: string; /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The diff of the line that the comment refers to. */ readonly diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ readonly html_url: string; /** @description The ID of the pull request review comment. */ readonly id: number; /** @description The comment ID to reply to. */ readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the pull request review comment. */ readonly node_id: string; /** @description The SHA of the original commit to which the comment applies. */ readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ readonly path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ readonly pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ readonly pull_request_url: string; /** Reactions */ @@ -76284,7 +81707,7 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -76292,9 +81715,13 @@ export interface components { * @enum {string} */ readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -76305,49 +81732,53 @@ export interface components { * @enum {string} */ readonly subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -76367,119 +81798,127 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -76490,48 +81929,56 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ readonly commit_title: string; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -76572,32 +82019,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -76607,28 +82054,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -76656,89 +82104,104 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -76752,36 +82215,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -76791,54 +82256,60 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; + /** @nullable */ readonly closed_at: string | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; readonly created_at: string; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; readonly draft: boolean; readonly head: { @@ -76872,32 +82343,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -76907,28 +82378,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -76956,89 +82428,104 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77052,36 +82539,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -77091,124 +82580,143 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -77221,72 +82729,80 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -77295,12 +82811,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -77308,36 +82824,43 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -77346,12 +82869,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -77359,63 +82882,67 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; readonly title: string; readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77427,17 +82954,17 @@ export interface components { readonly _links: { /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly pull_request: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; @@ -77451,20 +82978,23 @@ export interface components { readonly body: string; /** @description The SHA of the commit to which the comment applies. */ readonly commit_id: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; /** @description The diff of the line that the comment refers to. */ readonly diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ readonly html_url: string; /** @description The ID of the pull request review comment. */ readonly id: number; /** @description The comment ID to reply to. */ readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ readonly line: number | null; /** @description The node ID of the pull request review comment. */ readonly node_id: string; @@ -77474,17 +83004,26 @@ export interface components { readonly original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ readonly path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ readonly pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ readonly pull_request_url: string; /** Reactions */ @@ -77498,7 +83037,7 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @@ -77506,9 +83045,13 @@ export interface components { * @enum {string} */ readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ readonly start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -77519,49 +83062,53 @@ export interface components { * @enum {string} */ readonly subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77584,120 +83131,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -77708,48 +83263,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77790,32 +83356,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -77825,28 +83391,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -77874,37 +83441,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -77925,55 +83500,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -77987,11 +83569,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -78014,26 +83598,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78048,60 +83632,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -78136,32 +83728,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -78171,28 +83763,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -78220,37 +83813,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -78264,55 +83865,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -78326,11 +83934,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -78353,26 +83963,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78387,168 +83997,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -78561,74 +84198,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -78637,12 +84283,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -78650,36 +84296,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -78688,12 +84341,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -78701,69 +84354,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -78785,120 +84442,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -78909,48 +84574,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -78961,6 +84637,7 @@ export interface components { readonly merge_method: "merge" | "squash" | "rebase"; } | null; readonly base: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** @@ -78991,32 +84668,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -79026,28 +84703,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -79075,37 +84753,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -79126,55 +84812,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -79188,11 +84881,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -79215,26 +84910,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79249,68 +84944,78 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -79337,32 +85042,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -79372,28 +85077,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -79421,37 +85127,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -79472,55 +85186,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -79534,11 +85255,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -79561,26 +85284,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79595,168 +85318,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -79769,74 +85519,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -79845,12 +85604,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -79858,36 +85617,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -79896,12 +85662,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -79909,69 +85675,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -79993,120 +85763,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -80117,48 +85895,59 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ readonly commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -80199,32 +85988,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -80234,28 +86023,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -80283,37 +86073,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -80334,55 +86132,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -80396,11 +86201,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -80423,26 +86230,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80457,68 +86264,78 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { + /** @nullable */ readonly label: string | null; readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -80545,32 +86362,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -80580,28 +86397,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -80629,37 +86447,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -80673,55 +86499,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -80735,11 +86568,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -80762,26 +86597,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80796,168 +86631,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -80970,74 +86832,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; readonly node_id: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -81046,12 +86917,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -81059,36 +86930,43 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -81097,12 +86975,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -81110,69 +86988,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -81193,120 +87075,128 @@ export interface components { readonly _links: { /** Link */ readonly comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly commits: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly html: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly issue: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comment: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly review_comments: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly self: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; /** Link */ readonly statuses: { - /** Format: uri-template */ + /** @format uri-template */ readonly href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; readonly additions?: number; - /** User */ + /** + * User + * @nullable + */ readonly assignee: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly assignees: readonly ({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null)[]; /** @@ -81317,48 +87207,56 @@ export interface components { readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ readonly auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ readonly commit_title: string; - /** User */ + /** + * User + * @nullable + */ readonly enabled_by: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -81399,32 +87297,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -81434,28 +87332,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -81483,37 +87382,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -81534,55 +87441,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -81596,11 +87510,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -81623,26 +87539,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -81657,60 +87573,68 @@ export interface components { readonly web_commit_signoff_required?: boolean; }; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + /** @nullable */ readonly body: string | null; readonly changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly comments?: number; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commits?: number; - /** Format: uri */ + /** @format uri */ readonly commits_url: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly deletions?: number; - /** Format: uri */ + /** @format uri */ readonly diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; @@ -81719,6 +87643,7 @@ export interface components { readonly ref: string; /** * Repository + * @nullable * @description A git repository */ readonly repo: { @@ -81745,32 +87670,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; readonly created_at: number | string; /** @description The default branch of the repository. */ @@ -81780,28 +87705,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -81829,37 +87755,45 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; @@ -81880,55 +87814,62 @@ export interface components { * @enum {string} */ readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -81942,11 +87883,13 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; /** @@ -81969,26 +87912,26 @@ export interface components { readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -82003,168 +87946,195 @@ export interface components { readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issue_url: string; readonly labels: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; + /** @nullable */ readonly description: string | null; readonly id: number; /** @description The name of the label. */ readonly name: string; readonly node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ readonly url: string; }[]; readonly locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ readonly maintainer_can_modify?: boolean; + /** @nullable */ readonly merge_commit_sha: string | null; + /** @nullable */ readonly mergeable?: boolean | null; readonly mergeable_state?: string; + /** @nullable */ readonly merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ readonly merged_by?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ readonly milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly closed_at: string | null; readonly closed_issues: number; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; - /** User */ + /** + * User + * @nullable + */ readonly creator: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly due_on: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly labels_url: string; readonly node_id: string; /** @description The number of the milestone. */ @@ -82177,74 +88147,83 @@ export interface components { readonly state: "open" | "closed"; /** @description The title of the milestone. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null; readonly node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ + /** @format uri */ readonly patch_url: string; + /** @nullable */ readonly rebaseable?: boolean | null; readonly requested_reviewers: readonly (({ - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -82253,12 +88232,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -82266,36 +88245,43 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; })[]; readonly requested_teams: readonly { readonly deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description?: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url?: string; /** @description Name of the team */ readonly name: string; readonly node_id?: string; + /** @nullable */ readonly parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; /** @description Name of the team */ readonly name: string; @@ -82304,12 +88290,12 @@ export interface components { readonly permission: string; /** @enum {string} */ readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url: string; readonly slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url: string; } | null; @@ -82317,69 +88303,73 @@ export interface components { readonly permission?: string; /** @enum {string} */ readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ readonly repositories_url?: string; readonly slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ readonly url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ readonly review_comment_url: string; readonly review_comments?: number; - /** Format: uri */ + /** @format uri */ readonly review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ readonly state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ readonly statuses_url: string; /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** User */ + /** + * User + * @nullable + */ readonly user: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -82403,9 +88393,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -82416,9 +88409,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -82434,14 +88430,14 @@ export interface components { /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ readonly removed?: readonly string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ readonly timestamp: string; readonly tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ readonly url: string; }[]; @@ -82454,7 +88450,10 @@ export interface components { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ readonly forced: boolean; - /** Commit */ + /** + * Commit + * @nullable + */ readonly head_commit: { /** @description An array of files added in the commit. */ readonly added?: readonly string[]; @@ -82463,9 +88462,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -82476,9 +88478,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -82494,14 +88499,14 @@ export interface components { /** @description An array of files removed in the commit. */ readonly removed?: readonly string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ readonly timestamp: string; readonly tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ readonly url: string; } | null; @@ -82512,9 +88517,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly pusher: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email?: string | null; /** @description The git author's name. */ readonly name: string; @@ -82550,32 +88558,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -82589,28 +88597,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -82638,89 +88647,104 @@ export interface components { * @default false */ readonly has_discussions: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -82734,36 +88758,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -82781,7 +88807,9 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly registry_package: { + /** @nullable */ readonly created_at: string | null; + /** @nullable */ readonly description: string | null; readonly ecosystem: string; readonly html_url: string; @@ -82810,6 +88838,7 @@ export interface components { readonly user_view_type?: string; }; readonly package_type: string; + /** @nullable */ readonly package_version: { readonly author?: { readonly avatar_url: string; @@ -82835,7 +88864,9 @@ export interface components { readonly body?: string | Record; readonly body_html?: string; readonly container_metadata?: { + /** @nullable */ readonly labels?: Record | null; + /** @nullable */ readonly manifest?: Record | null; readonly tag?: { readonly digest?: string; @@ -82856,22 +88887,27 @@ export interface components { readonly [key: string]: unknown; }[]; readonly name: string; + /** @nullable */ readonly npm_metadata?: { readonly name?: string; readonly version?: string; readonly npm_user?: string; + /** @nullable */ readonly author?: (string | Record) | null; + /** @nullable */ readonly bugs?: (string | Record) | null; readonly dependencies?: Record; readonly dev_dependencies?: Record; readonly peer_dependencies?: Record; readonly optional_dependencies?: Record; readonly description?: string; + /** @nullable */ readonly dist?: (string | Record) | null; readonly git_head?: string; readonly homepage?: string; readonly license?: string; readonly main?: string; + /** @nullable */ readonly repository?: (string | Record) | null; readonly scripts?: Record; readonly id?: string; @@ -82885,6 +88921,7 @@ export interface components { readonly files?: readonly string[]; readonly bin?: Record; readonly man?: Record; + /** @nullable */ readonly directories?: (string | Record) | null; readonly os?: readonly string[]; readonly cpu?: readonly string[]; @@ -82895,7 +88932,9 @@ export interface components { readonly published_via_actions?: boolean; readonly deleted_by_id?: number; } | null; + /** @nullable */ readonly nuget_metadata?: readonly { + /** @nullable */ readonly id?: (string | Record | number) | null; readonly name?: string; readonly value?: boolean | string | number | { @@ -82910,11 +88949,15 @@ export interface components { readonly created_at: string; readonly download_url: string; readonly id: number; + /** @nullable */ readonly md5: string | null; readonly name: string; + /** @nullable */ readonly sha1: string | null; + /** @nullable */ readonly sha256: string | null; readonly size: number; + /** @nullable */ readonly state: string | null; readonly updated_at: string; }[]; @@ -82946,6 +88989,7 @@ export interface components { readonly draft?: boolean; readonly html_url?: string; readonly id?: number; + /** @nullable */ readonly name?: string | null; readonly prerelease?: boolean; readonly published_at?: string; @@ -82961,6 +89005,7 @@ export interface components { readonly updated_at?: string; readonly version: string; } | null; + /** @nullable */ readonly registry: { readonly about_url?: string; readonly name?: string; @@ -82968,6 +89013,7 @@ export interface components { readonly url?: string; readonly vendor?: string; } | null; + /** @nullable */ readonly updated_at: string | null; }; readonly repository?: components["schemas"]["repository-webhooks"]; @@ -82981,6 +89027,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly registry_package: { readonly created_at: string; + /** @nullable */ readonly description: unknown; readonly ecosystem: string; readonly html_url: string; @@ -83052,8 +89099,10 @@ export interface components { readonly created_at?: string; readonly download_url?: string; readonly id?: number; + /** @nullable */ readonly md5?: string | null; readonly name?: string; + /** @nullable */ readonly sha1?: string | null; readonly sha256?: string; readonly size?: number; @@ -83103,6 +89152,7 @@ export interface components { readonly updated_at: string; readonly version: string; }; + /** @nullable */ readonly registry: Record | null; readonly updated_at: string; }; @@ -83169,13 +89219,14 @@ export interface components { */ readonly release: { readonly assets: readonly ({ - /** Format: uri */ + /** @format uri */ readonly browser_download_url: string; readonly content_type: string; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly download_count: number; readonly id: number; + /** @nullable */ readonly label: string | null; /** @description The file name of the asset. */ readonly name: string; @@ -83186,98 +89237,111 @@ export interface components { * @enum {string} */ readonly state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** User */ + /** + * User + * @nullable + */ readonly uploader?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ readonly assets_url: string; - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; + /** @nullable */ readonly body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly created_at: string | null; - /** Format: uri */ + /** @format uri */ readonly discussion_url?: string; /** @description Whether the release is a draft or published */ readonly draft: boolean; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; + /** @nullable */ readonly name: string | null; readonly node_id: string; /** @@ -83285,7 +89349,10 @@ export interface components { * @enum {boolean} */ readonly prerelease: true; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ readonly published_at: string | null; /** Reactions */ readonly reactions?: { @@ -83298,20 +89365,26 @@ export interface components { readonly laugh: number; readonly rocket: number; readonly total_count: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }; /** @description The name of the tag. */ readonly tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ readonly target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ readonly upload_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly zipball_url: string | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -83407,7 +89480,10 @@ export interface components { /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ readonly action: string; readonly branch: string; - /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + /** + * @nullable + * @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + */ readonly client_payload: { readonly [key: string]: unknown; } | null; @@ -83426,12 +89502,15 @@ export interface components { readonly from: string; }; readonly description?: { + /** @nullable */ readonly from: string | null; }; readonly homepage?: { + /** @nullable */ readonly from: string | null; }; readonly topics?: { + /** @nullable */ readonly from?: readonly string[] | null; }; }; @@ -83577,65 +89656,70 @@ export interface components { readonly from: { /** Organization */ readonly organization?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly events_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly issues_url: string; readonly login: string; - /** Format: uri-template */ + /** @format uri-template */ readonly members_url: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly public_members_url: string; - /** Format: uri */ + /** @format uri */ readonly repos_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** User */ + /** + * User + * @nullable + */ readonly user?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; - /** Format: int64 */ + /** @format int64 */ readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -83681,52 +89765,60 @@ export interface components { readonly affected_package_name: string; readonly affected_range: string; readonly created_at: string; + /** @nullable */ readonly dismiss_comment?: string | null; readonly dismiss_reason: string; readonly dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ readonly dismisser: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; readonly external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_reference: string | null; readonly fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ readonly fixed_at?: string; readonly fixed_in?: string; readonly ghsa_id: string; @@ -83768,48 +89860,55 @@ export interface components { readonly created_at: string; readonly dismiss_reason?: string; readonly dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ readonly dismisser?: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; readonly external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly external_reference: string | null; readonly fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ readonly fixed_at?: string; readonly fixed_in?: string; readonly ghsa_id: string; @@ -83912,20 +90011,27 @@ export interface components { */ readonly source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly started_at: string; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly completed_at: string; - /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + /** + * @nullable + * @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates + */ readonly secret_types?: readonly string[] | null; - /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + /** + * @nullable + * @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated + */ readonly custom_pattern_name?: string | null; /** + * @nullable * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated * @enum {string|null} */ @@ -83970,6 +90076,7 @@ export interface components { readonly security_advisory: { readonly cvss: { readonly score: number; + /** @nullable */ readonly vector_string: string | null; }; readonly cvss_severities?: components["schemas"]["cvss-severities"]; @@ -83985,13 +90092,14 @@ export interface components { }[]; readonly published_at: string; readonly references: readonly { - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly severity: string; readonly summary: string; readonly updated_at: string; readonly vulnerabilities: readonly { + /** @nullable */ readonly first_patched_version: { readonly identifier: string; } | null; @@ -84104,7 +90212,10 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ readonly starred_at: string | null; }; /** star deleted event */ @@ -84116,68 +90227,85 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ readonly starred_at: unknown; }; /** status event */ readonly "webhook-status": { - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly avatar_url?: string | null; /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */ readonly branches: readonly { readonly commit: { + /** @nullable */ readonly sha: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; }; readonly name: string; readonly protected: boolean; }[]; readonly commit: { - /** User */ + /** + * User + * @nullable + */ readonly author: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id?: number; readonly login?: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly comments_url: string; readonly commit: { readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -84189,9 +90317,12 @@ export interface components { }; readonly comment_count: number; readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -84204,74 +90335,84 @@ export interface components { readonly message: string; readonly tree: { readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly verification: { + /** @nullable */ readonly payload: string | null; /** @enum {string} */ readonly reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; + /** @nullable */ readonly signature: string | null; readonly verified: boolean; + /** @nullable */ readonly verified_at?: string | null; }; }; - /** User */ + /** + * User + * @nullable + */ readonly committer: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id?: number; readonly login?: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly node_id: string; readonly parents: readonly { - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; readonly sha: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly context: string; readonly created_at: string; - /** @description The optional human-readable description added to the status. */ + /** + * @nullable + * @description The optional human-readable description added to the status. + */ readonly description: string | null; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ @@ -84288,7 +90429,10 @@ export interface components { * @enum {string} */ readonly state: "pending" | "success" | "failure" | "error"; - /** @description The optional link added to the status. */ + /** + * @nullable + * @description The optional link added to the status. + */ readonly target_url: string | null; readonly updated_at: string; }; @@ -84400,32 +90544,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84439,28 +90583,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -84483,89 +90628,104 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -84579,36 +90739,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -84653,32 +90815,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84692,28 +90854,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -84736,89 +90899,104 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -84832,36 +91010,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -84906,32 +91086,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84945,28 +91125,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -84989,89 +91170,104 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -85085,36 +91281,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -85190,32 +91388,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85229,28 +91427,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -85273,89 +91472,104 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -85369,36 +91583,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -85443,32 +91659,32 @@ export interface components { */ readonly allow_squash_merge: boolean; readonly allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; /** * @description Whether the repository is archived. * @default false */ readonly archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri */ + /** @format uri */ readonly clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85482,28 +91698,29 @@ export interface components { * @default false */ readonly delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; /** @description Returns whether or not this repository is disabled. */ readonly disabled?: boolean; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; readonly forks: number; readonly forks_count: number; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly git_url: string; /** * @description Whether downloads are enabled. @@ -85526,89 +91743,104 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** @nullable */ readonly homepage: string | null; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ readonly id: number; readonly is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; + /** @nullable */ readonly language: string | null; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** License */ + /** + * License + * @nullable + */ readonly license: { readonly key: string; readonly name: string; readonly node_id: string; readonly spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly url: string | null; } | null; readonly master_branch?: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly mirror_url: string | null; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; readonly open_issues: number; readonly open_issues_count: number; readonly organization?: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; @@ -85622,36 +91854,38 @@ export interface components { /** @description Whether the repository is private or public. */ readonly private: boolean; readonly public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; + /** @nullable */ readonly pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; + /** @nullable */ readonly role_name?: string | null; readonly size: number; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly svn_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; readonly topics: readonly string[]; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; @@ -85674,6 +91908,7 @@ export interface components { /** workflow_dispatch event */ readonly "webhook-workflow-dispatch": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @nullable */ readonly inputs: { readonly [key: string]: unknown; } | null; @@ -85694,15 +91929,19 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { - /** Format: uri */ + /** @format uri */ readonly check_run_url: string; + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ readonly created_at: string; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85711,15 +91950,27 @@ export interface components { readonly node_id: string; readonly run_attempt: number; readonly run_id: number; - /** Format: uri */ + /** @format uri */ readonly run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_name: string | null; readonly started_at: string; /** @@ -85727,21 +91978,32 @@ export interface components { * @enum {string} */ readonly status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name: string | null; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "in_progress" | "completed" | "queued"; }[]; - /** Format: uri */ + /** @format uri */ readonly url: string; } & { readonly check_run_url?: string; @@ -85759,15 +92021,25 @@ export interface components { readonly run_attempt?: number; readonly run_id?: number; readonly run_url?: string; + /** @nullable */ readonly runner_group_id?: number | null; + /** @nullable */ readonly runner_group_name?: string | null; + /** @nullable */ readonly runner_id?: number | null; + /** @nullable */ readonly runner_name?: string | null; readonly started_at?: string; readonly status?: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name?: string | null; readonly steps?: readonly (Record | null)[]; readonly url?: string; @@ -85784,15 +92056,19 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { - /** Format: uri */ + /** @format uri */ readonly check_run_url: string; + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | null | "cancelled" | "neutral"; /** @description The time that the job created. */ readonly created_at: string; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85801,15 +92077,27 @@ export interface components { readonly node_id: string; readonly run_attempt: number; readonly run_id: number; - /** Format: uri */ + /** @format uri */ readonly run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ readonly runner_name: string | null; readonly started_at: string; /** @@ -85817,25 +92105,38 @@ export interface components { * @enum {string} */ readonly status: "queued" | "in_progress" | "completed"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name: string | null; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "failure" | "skipped" | "success" | null | "cancelled"; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "in_progress" | "completed" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ readonly url: string; } & { readonly check_run_url?: string; + /** @nullable */ readonly completed_at?: string | null; + /** @nullable */ readonly conclusion?: string | null; /** @description The time that the job created. */ readonly created_at?: string; @@ -85848,22 +92149,35 @@ export interface components { readonly run_attempt?: number; readonly run_id?: number; readonly run_url?: string; + /** @nullable */ readonly runner_group_id?: number | null; + /** @nullable */ readonly runner_group_name?: string | null; + /** @nullable */ readonly runner_id?: number | null; + /** @nullable */ readonly runner_name?: string | null; readonly started_at?: string; /** @enum {string} */ readonly status: "in_progress" | "completed" | "queued"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name?: string | null; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; + /** @nullable */ readonly conclusion: string | null; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "in_progress" | "completed" | "pending" | "queued"; @@ -85882,14 +92196,16 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { - /** Format: uri */ + /** @format uri */ readonly check_run_url: string; + /** @nullable */ readonly completed_at: string | null; + /** @nullable */ readonly conclusion: string | null; /** @description The time that the job created. */ readonly created_at: string; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly labels: readonly string[]; @@ -85897,31 +92213,46 @@ export interface components { readonly node_id: string; readonly run_attempt: number; readonly run_id: number; - /** Format: uri */ + /** @format uri */ readonly run_url: string; + /** @nullable */ readonly runner_group_id: number | null; + /** @nullable */ readonly runner_group_name: string | null; + /** @nullable */ readonly runner_id: number | null; + /** @nullable */ readonly runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ readonly started_at: string; /** @enum {string} */ readonly status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name: string | null; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "completed" | "in_progress" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly deployment?: components["schemas"]["deployment"]; @@ -85936,14 +92267,16 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { - /** Format: uri */ + /** @format uri */ readonly check_run_url: string; + /** @nullable */ readonly completed_at: string | null; + /** @nullable */ readonly conclusion: string | null; /** @description The time that the job created. */ readonly created_at: string; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; readonly labels: readonly string[]; @@ -85951,31 +92284,46 @@ export interface components { readonly node_id: string; readonly run_attempt: number; readonly run_id: number; - /** Format: uri */ + /** @format uri */ readonly run_url: string; + /** @nullable */ readonly runner_group_id: number | null; + /** @nullable */ readonly runner_group_name: string | null; + /** @nullable */ readonly runner_id: number | null; + /** @nullable */ readonly runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ readonly started_at: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ readonly head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ readonly workflow_name: string | null; /** @enum {string} */ readonly status: "queued" | "in_progress" | "completed" | "waiting"; readonly steps: readonly { + /** @nullable */ readonly completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; readonly name: string; readonly number: number; + /** @nullable */ readonly started_at: string | null; /** @enum {string} */ readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; }[]; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly deployment?: components["schemas"]["deployment"]; @@ -85992,57 +92340,65 @@ export interface components { readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly artifacts_url: string; - /** Format: uri */ + /** @format uri */ readonly cancel_url: string; readonly check_suite_id: number; readonly check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ readonly check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; + /** @nullable */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -86051,9 +92407,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86064,9 +92423,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86079,143 +92441,152 @@ export interface components { }; /** Repository Lite */ readonly head_repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly jobs_url: string; - /** Format: uri */ + /** @format uri */ readonly logs_url: string; + /** @nullable */ readonly name: string | null; readonly node_id: string; readonly path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly previous_attempt_url: string | null; readonly pull_requests: readonly ({ readonly base: { @@ -86224,7 +92595,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -86235,16 +92606,17 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null)[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -86252,183 +92624,192 @@ export interface components { }[] | null; /** Repository Lite */ readonly repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly rerun_url: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; - /** Format: uri */ + /** @format uri */ readonly workflow_url: string; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. @@ -86449,56 +92830,64 @@ export interface components { readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly artifacts_url: string; - /** Format: uri */ + /** @format uri */ readonly cancel_url: string; readonly check_suite_id: number; readonly check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ readonly check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; + /** @nullable */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -86507,9 +92896,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86520,9 +92912,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86535,142 +92930,154 @@ export interface components { }; /** Repository Lite */ readonly head_repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; - /** @description The name of the repository. */ + /** + * @nullable + * @description The name of the repository. + */ readonly name: string | null; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly jobs_url: string; - /** Format: uri */ + /** @format uri */ readonly logs_url: string; + /** @nullable */ readonly name: string | null; readonly node_id: string; readonly path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly previous_attempt_url: string | null; readonly pull_requests: readonly ({ readonly base: { @@ -86679,7 +93086,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -86690,16 +93097,17 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; } | null)[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -86707,181 +93115,190 @@ export interface components { }[] | null; /** Repository Lite */ readonly repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly rerun_url: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; - /** Format: uri */ + /** @format uri */ readonly workflow_url: string; }; }; @@ -86897,57 +93314,65 @@ export interface components { readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { - /** User */ + /** + * User + * @nullable + */ readonly actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ readonly artifacts_url: string; - /** Format: uri */ + /** @format uri */ readonly cancel_url: string; readonly check_suite_id: number; readonly check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ readonly check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ readonly created_at: string; readonly event: string; + /** @nullable */ readonly head_branch: string | null; /** SimpleCommit */ readonly head_commit: { @@ -86956,9 +93381,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly author: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86969,9 +93397,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ readonly committer: { - /** Format: date-time */ + /** @format date-time */ readonly date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ readonly email: string | null; /** @description The git author's name. */ readonly name: string; @@ -86984,143 +93415,152 @@ export interface components { }; /** Repository Lite */ readonly head_repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly head_sha: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ + /** @format uri */ readonly jobs_url: string; - /** Format: uri */ + /** @format uri */ readonly logs_url: string; + /** @nullable */ readonly name: string | null; readonly node_id: string; readonly path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ readonly previous_attempt_url: string | null; readonly pull_requests: readonly { readonly base: { @@ -87129,7 +93569,7 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; @@ -87140,16 +93580,17 @@ export interface components { readonly repo: { readonly id: number; readonly name: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; readonly sha: string; }; readonly id: number; readonly number: number; - /** Format: uri */ + /** @format uri */ readonly url: string; }[]; + /** @nullable */ readonly referenced_workflows?: readonly { readonly path: string; readonly ref?: string; @@ -87157,183 +93598,192 @@ export interface components { }[] | null; /** Repository Lite */ readonly repository: { - /** Format: uri-template */ + /** @format uri-template */ readonly archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly contents_url: string; - /** Format: uri */ + /** @format uri */ readonly contributors_url: string; - /** Format: uri */ + /** @format uri */ readonly deployments_url: string; + /** @nullable */ readonly description: string | null; - /** Format: uri */ + /** @format uri */ readonly downloads_url: string; - /** Format: uri */ + /** @format uri */ readonly events_url: string; readonly fork: boolean; - /** Format: uri */ + /** @format uri */ readonly forks_url: string; readonly full_name: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly git_tags_url: string; - /** Format: uri */ + /** @format uri */ readonly hooks_url: string; - /** Format: uri */ + /** @format uri */ readonly html_url: string; /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly labels_url: string; - /** Format: uri */ + /** @format uri */ readonly languages_url: string; - /** Format: uri */ + /** @format uri */ readonly merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** Format: uri-template */ + /** @format uri-template */ readonly notifications_url: string; - /** User */ + /** + * User + * @nullable + */ readonly owner: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly releases_url: string; - /** Format: uri */ + /** @format uri */ readonly stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly statuses_url: string; - /** Format: uri */ + /** @format uri */ readonly subscribers_url: string; - /** Format: uri */ + /** @format uri */ readonly subscription_url: string; - /** Format: uri */ + /** @format uri */ readonly tags_url: string; - /** Format: uri */ + /** @format uri */ readonly teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ readonly trees_url: string; - /** Format: uri */ + /** @format uri */ readonly url: string; }; - /** Format: uri */ + /** @format uri */ readonly rerun_url: string; readonly run_attempt: number; readonly run_number: number; - /** Format: date-time */ + /** @format date-time */ readonly run_started_at: string; /** @enum {string} */ readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ readonly triggering_actor: { - /** Format: uri */ + /** @format uri */ readonly avatar_url?: string; readonly deleted?: boolean; + /** @nullable */ readonly email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ readonly events_url?: string; - /** Format: uri */ + /** @format uri */ readonly followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ + /** @format uri */ readonly html_url?: string; readonly id: number; readonly login: string; readonly name?: string; readonly node_id?: string; - /** Format: uri */ + /** @format uri */ readonly organizations_url?: string; - /** Format: uri */ + /** @format uri */ readonly received_events_url?: string; - /** Format: uri */ + /** @format uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ readonly starred_url?: string; - /** Format: uri */ + /** @format uri */ readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ readonly url?: string; readonly user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ readonly updated_at: string; - /** Format: uri */ + /** @format uri */ readonly url: string; readonly workflow_id: number; - /** Format: uri */ + /** @format uri */ readonly workflow_url: string; readonly display_title: string; }; @@ -87450,6 +93900,7 @@ export interface components { readonly block?: { readonly reason?: string; readonly created_at?: string; + /** @nullable */ readonly html_url?: string | null; }; readonly message?: string; @@ -88237,6 +94688,7 @@ export interface operations { readonly "application/json": components["schemas"]["integration"] & ({ readonly client_id: string; readonly client_secret: string; + /** @nullable */ readonly webhook_secret: string | null; readonly pem: string; } & { @@ -89824,7 +96276,10 @@ export interface operations { readonly [key: string]: { /** @description The new content of the file. */ readonly content?: string; - /** @description The new filename for the file. */ + /** + * @nullable + * @description The new filename for the file. + */ readonly filename?: string | null; } | null; }; @@ -90760,8 +97215,8 @@ export interface operations { readonly content: { readonly "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ readonly last_read_at?: string; /** @description Whether the notification has been read. */ @@ -91359,7 +97814,10 @@ export interface operations { * @enum {string} */ readonly source?: "github" | "partner" | "custom"; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ readonly version?: string | null; }; /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ @@ -91586,7 +98044,10 @@ export interface operations { readonly maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ readonly enable_static_ip?: boolean; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ readonly image_version?: string | null; }; }; @@ -92076,7 +98537,10 @@ export interface operations { readonly restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ readonly selected_workflows?: readonly string[]; - /** @description The identifier of a hosted compute network configuration. */ + /** + * @nullable + * @description The identifier of a hosted compute network configuration. + */ readonly network_configuration_id?: string | null; }; }; @@ -92742,7 +99206,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -94183,7 +100650,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -94877,7 +101347,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -97426,7 +103899,10 @@ export interface operations { * @enum {string} */ readonly action: "approve" | "deny"; - /** @description Reason for approving or denying the requests. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the requests. Max 1024 characters. + */ readonly reason?: string | null; }; }; @@ -97459,7 +103935,10 @@ export interface operations { * @enum {string} */ readonly action: "approve" | "deny"; - /** @description Reason for approving or denying the request. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the request. Max 1024 characters. + */ readonly reason?: string | null; }; }; @@ -97701,9 +104180,15 @@ export interface operations { * @enum {string} */ readonly registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ readonly username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ readonly key_id: string; @@ -97838,9 +104323,15 @@ export interface operations { * @enum {string} */ readonly registry_type?: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ readonly username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -99362,7 +105853,10 @@ export interface operations { * @enum {string} */ readonly permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ readonly parent_team_id?: number | null; }; }; @@ -100547,6 +107041,7 @@ export interface operations { readonly content: { readonly "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100592,6 +107087,7 @@ export interface operations { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom + * @pattern ^(?:top|bottom|after:\d+)$ */ readonly position: string; /** @@ -100787,6 +107283,7 @@ export interface operations { readonly content: { readonly "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100862,6 +107359,7 @@ export interface operations { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last + * @pattern ^(?:first|last|after:\d+)$ */ readonly position: string; }; @@ -100966,6 +107464,7 @@ export interface operations { */ readonly name?: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -101347,6 +107846,7 @@ export interface operations { */ readonly visibility?: "public" | "private"; /** + * @nullable * @description Specify which security and analysis features to enable or disable for the repository. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -103265,7 +109765,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -104224,7 +110727,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Require status checks to pass before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require status checks to pass before merging. Set to `null` to disable. + */ readonly required_status_checks: { /** @description Require branches to be up to date before merging. */ readonly strict: boolean; @@ -104241,9 +110747,15 @@ export interface operations { readonly app_id?: number; }[]; } | null; - /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ + /** + * @nullable + * @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ readonly enforce_admins: boolean | null; - /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ readonly required_pull_request_reviews: { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ readonly dismissal_restrictions?: { @@ -104275,7 +110787,10 @@ export interface operations { readonly apps?: readonly string[]; }; } | null; - /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ + /** + * @nullable + * @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ readonly restrictions: { /** @description The list of user `login`s with push access */ readonly users: readonly string[]; @@ -104286,7 +110801,10 @@ export interface operations { } | null; /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ readonly required_linear_history?: boolean; - /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + /** + * @nullable + * @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ readonly allow_force_pushes?: boolean | null; /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ readonly allow_deletions?: boolean; @@ -105382,8 +111900,8 @@ export interface operations { */ readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** - * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly started_at?: string; /** @@ -105393,8 +111911,8 @@ export interface operations { */ readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -105524,8 +112042,8 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ readonly external_id?: string; /** - * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly started_at?: string; /** @@ -105540,8 +112058,8 @@ export interface operations { */ readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -106560,15 +113078,15 @@ export interface operations { readonly ref: components["schemas"]["code-scanning-ref-full"]; readonly sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** - * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ + * @format uri */ readonly checkout_uri?: string; /** - * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ @@ -106927,6 +113445,7 @@ export interface operations { readonly billable_owner?: components["schemas"]["simple-user"]; readonly defaults?: { readonly location: string; + /** @nullable */ readonly devcontainer_path: string | null; }; }; @@ -107075,7 +113594,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -108470,7 +114992,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id?: string; @@ -108697,6 +115222,7 @@ export interface operations { */ readonly environment?: string; /** + * @nullable * @description Short description of the deployment. * @default */ @@ -109046,7 +115572,10 @@ export interface operations { readonly "application/json": { readonly wait_timer?: components["schemas"]["wait-timer"]; readonly prevent_self_review?: components["schemas"]["prevent-self-review"]; - /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ + /** + * @nullable + * @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + */ readonly reviewers?: readonly { readonly type?: components["schemas"]["deployment-reviewer-type"]; /** @@ -109552,7 +116081,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id: string; @@ -109982,8 +116514,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ readonly email: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly date?: string; }; @@ -109994,8 +116526,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ readonly email?: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly date?: string; }; @@ -110259,8 +116791,8 @@ export interface operations { /** @description The email of the author of the tag */ readonly email: string; /** - * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly date?: string; }; @@ -110341,6 +116873,7 @@ export interface operations { */ readonly type?: "blob" | "tree" | "commit"; /** + * @nullable * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. @@ -111364,14 +117897,20 @@ export interface operations { readonly title: string | number; /** @description The contents of the issue. */ readonly body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ + /** + * @nullable + * @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ + */ readonly assignee?: string | null; + /** @nullable */ readonly milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ readonly labels?: readonly (string | { readonly id?: number; readonly name?: string; + /** @nullable */ readonly description?: string | null; + /** @nullable */ readonly color?: string | null; })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ @@ -111745,11 +118284,20 @@ export interface operations { readonly requestBody?: { readonly content: { readonly "application/json": { - /** @description The title of the issue. */ + /** + * @nullable + * @description The title of the issue. + */ readonly title?: (string | number) | null; - /** @description The contents of the issue. */ + /** + * @nullable + * @description The contents of the issue. + */ readonly body?: string | null; - /** @description Username to assign to this issue. **This field is closing down.** */ + /** + * @nullable + * @description Username to assign to this issue. **This field is closing down.** + */ readonly assignee?: string | null; /** * @description The open or closed state of the issue. @@ -111757,17 +118305,21 @@ export interface operations { */ readonly state?: "open" | "closed"; /** + * @nullable * @description The reason for the state change. Ignored unless `state` is changed. * @example not_planned * @enum {string|null} */ readonly state_reason?: "completed" | "not_planned" | "reopened" | null; + /** @nullable */ readonly milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ readonly labels?: readonly (string | { readonly id?: number; readonly name?: string; + /** @nullable */ readonly description?: string | null; + /** @nullable */ readonly color?: string | null; })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ @@ -113073,8 +119625,8 @@ export interface operations { /** @description A description of the milestone. */ readonly description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly due_on?: string; }; @@ -113178,8 +119730,8 @@ export interface operations { /** @description A description of the milestone. */ readonly description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly due_on?: string; }; @@ -113285,8 +119837,8 @@ export interface operations { readonly content: { readonly "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ readonly last_read_at?: string; }; @@ -113355,7 +119907,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ + /** + * @nullable + * @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." + */ readonly cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ readonly https_enforced?: boolean; @@ -113981,9 +120536,9 @@ export interface operations { /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ readonly head: string; /** - * Format: repo.nwo * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. * @example octo-org/octo-repo + * @format repo.nwo */ readonly head_repo?: string; /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ @@ -113995,9 +120550,9 @@ export interface operations { /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ readonly draft?: boolean; /** - * Format: int64 * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. * @example 1 + * @format int64 */ readonly issue?: number; }; @@ -116844,12 +123399,16 @@ export interface operations { */ readonly state: "error" | "failure" | "pending" | "success"; /** + * @nullable * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ readonly target_url?: string | null; - /** @description A short description of the status. */ + /** + * @nullable + * @description A short description of the status. + */ readonly description?: string | null; /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. @@ -117915,7 +124474,10 @@ export interface operations { * @enum {string} */ readonly permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ readonly parent_team_id?: number | null; }; }; @@ -118999,6 +125561,7 @@ export interface operations { */ readonly blog?: string; /** + * @nullable * @description The new Twitter username of the user. * @example therealomarj */ @@ -119358,7 +125921,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ readonly encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ readonly key_id: string; @@ -120489,7 +127055,10 @@ export interface operations { * @example Personal MacBook Air */ readonly title?: string; - /** @description The public SSH key to add to your GitHub account. */ + /** + * @description The public SSH key to add to your GitHub account. + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) + */ readonly key: string; }; }; @@ -121228,6 +127797,7 @@ export interface operations { */ readonly name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -121720,7 +128290,10 @@ export interface operations { * @example Personal MacBook Air */ readonly title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** + * @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com + */ readonly key: string; }; }; diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index 2d47a1d10..bb6086e54 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -24486,74 +24486,74 @@ export interface webhooks { export interface components { schemas: { root: { - /** Format: uri-template */ + /** @format uri-template */ current_user_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_authorizations_html_url: string; - /** Format: uri-template */ + /** @format uri-template */ authorizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ code_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ commit_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ emails_url: string; - /** Format: uri-template */ + /** @format uri-template */ emojis_url: string; - /** Format: uri-template */ + /** @format uri-template */ events_url: string; - /** Format: uri-template */ + /** @format uri-template */ feeds_url: string; - /** Format: uri-template */ + /** @format uri-template */ followers_url: string; - /** Format: uri-template */ + /** @format uri-template */ following_url: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url: string; /** - * Format: uri-template * @deprecated + * @format uri-template */ hub_url?: string; - /** Format: uri-template */ + /** @format uri-template */ issue_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ label_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ public_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ rate_limit_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ topic_search_url?: string; - /** Format: uri-template */ + /** @format uri-template */ user_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_organizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_search_url: string; }; /** @@ -24605,31 +24605,31 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 + * @format int64 * @example 1 */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri + * @format uri * @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ gravatar_id: string | null; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/followers */ followers_url: string; @@ -24640,24 +24640,24 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/subscriptions */ subscriptions_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/orgs */ organizations_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/repos */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/received_events */ received_events_url: string; @@ -24683,13 +24683,13 @@ export interface components { /** @description The API URL for the advisory. */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** - * Format: uri * @description The API URL for the repository advisory. + * @format uri */ readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ @@ -24707,8 +24707,8 @@ export interface components { */ severity: "critical" | "high" | "medium" | "low" | "unknown"; /** - * Format: uri * @description The URL of the advisory's source code. + * @format uri */ source_code_location: string | null; readonly identifiers: { @@ -24722,29 +24722,29 @@ export interface components { }[] | null; references: string[] | null; /** - * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + * @format date-time */ readonly github_reviewed_at: string | null; /** - * Format: date-time * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. * This field is only populated when the advisory is imported from the National Vulnerability Database. + * @format date-time */ readonly nvd_published_at: string | null; /** - * Format: date-time * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ @@ -24796,13 +24796,13 @@ export interface components { /** @description A short description of the enterprise. */ description?: string | null; /** - * Format: uri + * @format uri * @example https://github.com/enterprises/octo-business */ html_url: string; /** - * Format: uri * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -24823,16 +24823,16 @@ export interface components { */ slug: string; /** - * Format: date-time + * @format date-time * @example 2019-01-26T19:01:12Z */ created_at: string | null; /** - * Format: date-time + * @format date-time * @example 2019-01-26T19:14:43Z */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** @@ -24863,22 +24863,22 @@ export interface components { /** @example The description of the app. */ description: string | null; /** - * Format: uri + * @format uri * @example https://example.com */ external_url: string; /** - * Format: uri + * @format uri * @example https://github.com/apps/super-ci */ html_url: string; /** - * Format: date-time + * @format date-time * @example 2017-07-08T16:18:44-04:00 */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2017-07-08T16:18:44-04:00 */ updated_at: string; @@ -24917,8 +24917,8 @@ export interface components { pem?: string; } | null; /** - * Format: uri * @description The URL to which the payloads will be delivered. + * @format uri * @example https://example.com/webhook */ "webhook-config-url": string; @@ -24959,8 +24959,8 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the webhook delivery occurred. + * @format date-time * @example 2021-05-12T20:33:44Z */ delivered_at: string; @@ -25005,8 +25005,8 @@ export interface components { */ repository_id: number | null; /** - * Format: date-time * @description Time when the webhook delivery was throttled. + * @format date-time * @example 2021-05-12T20:33:44Z */ throttled_at?: string | null; @@ -25055,8 +25055,8 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the delivery was delivered. + * @format date-time * @example 2021-05-12T20:33:44Z */ delivered_at: string; @@ -25101,8 +25101,8 @@ export interface components { */ repository_id: number | null; /** - * Format: date-time * @description Time when the webhook delivery was throttled. + * @format date-time * @example 2021-05-12T20:33:44Z */ throttled_at?: string | null; @@ -25145,7 +25145,7 @@ export interface components { account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; requester: components["schemas"]["simple-user"]; /** - * Format: date-time + * @format date-time * @example 2022-07-08T16:18:44-04:00 */ created_at: string; @@ -25419,17 +25419,17 @@ export interface components { */ repository_selection: "all" | "selected"; /** - * Format: uri + * @format uri * @example https://api.github.com/app/installations/1/access_tokens */ access_tokens_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/installation/repositories */ repositories_url: string; /** - * Format: uri + * @format uri * @example https://github.com/organizations/github/settings/installations/1 */ html_url: string; @@ -25441,9 +25441,9 @@ export interface components { target_type: string; permissions: components["schemas"]["app-permissions"]; events: string[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** @example config.yaml */ single_file_name: string | null; @@ -25457,7 +25457,7 @@ export interface components { /** @example github-actions */ app_slug: string; suspended_by: null | components["schemas"]["simple-user"]; - /** Format: date-time */ + /** @format date-time */ suspended_at: string | null; /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ contact_email?: string | null; @@ -25472,7 +25472,7 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @format uri * @example https://api.github.com/licenses/mit */ url: string | null; @@ -25480,7 +25480,7 @@ export interface components { spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; }; /** @@ -25489,8 +25489,8 @@ export interface components { */ repository: { /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 * @example 42 */ id: number; @@ -25519,7 +25519,7 @@ export interface components { */ private: boolean; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World */ html_url: string; @@ -25527,7 +25527,7 @@ export interface components { description: string | null; fork: boolean; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World */ url: string; @@ -25550,27 +25550,27 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ contributors_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ deployments_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ downloads_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/events */ events_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ forks_url: string; @@ -25593,12 +25593,12 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ languages_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ merges_url: string; @@ -25613,29 +25613,29 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ subscribers_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ subscription_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ tags_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ teams_url: string; @@ -25644,22 +25644,22 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @format uri * @example git:git.example.com/octocat/Hello-World */ mirror_url: string | null; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ hooks_url: string; /** - * Format: uri + * @format uri * @example https://svn.github.com/octocat/Hello-World */ svn_url: string; /** - * Format: uri + * @format uri * @example https://github.com */ homepage: string | null; @@ -25734,17 +25734,17 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:06:43Z */ pushed_at: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ created_at: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:14:43Z */ updated_at: string | null; @@ -25879,7 +25879,7 @@ export interface components { */ single_file_paths?: string[]; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/repos */ repositories_url: string; @@ -25890,9 +25890,9 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { - /** Format: int64 */ + /** @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ url: string; /** @description A list of scopes that this authorization is in. */ scopes: string[] | null; @@ -25902,20 +25902,20 @@ export interface components { app: { client_id: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; note: string | null; - /** Format: uri */ + /** @format uri */ note_url: string | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; fingerprint: string | null; user?: null | components["schemas"]["simple-user"]; installation?: null | components["schemas"]["scoped-installation"]; - /** Format: date-time */ + /** @format date-time */ expires_at: string | null; }; /** @@ -25934,8 +25934,8 @@ export interface components { */ full_name: string; /** - * Format: uri * @description The URL to view the repository on GitHub.com. + * @format uri * @example https://github.com/octocat/Hello-World */ html_url: string; @@ -25964,7 +25964,7 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri + * @format uri * @example https://github.com/github */ html_url: string; @@ -26087,8 +26087,8 @@ export interface components { */ language: string; /** - * Format: date-time * @description The time at which the assignment is due. + * @format date-time * @example 2011-01-26T19:06:43Z */ deadline: string | null; @@ -26105,12 +26105,12 @@ export interface components { /** @example octocat */ login: string; /** - * Format: uri + * @format uri * @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat */ html_url: string; @@ -26228,8 +26228,8 @@ export interface components { */ language: string; /** - * Format: date-time * @description The time at which the assignment is due. + * @format date-time * @example 2011-01-26T19:06:43Z */ deadline: string | null; @@ -26307,7 +26307,7 @@ export interface components { /** @example Contributor Covenant */ name: string; /** - * Format: uri + * @format uri * @example https://api.github.com/codes_of_conduct/contributor_covenant */ url: string; @@ -26359,7 +26359,7 @@ export interface components { * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). */ body?: string; - /** Format: uri */ + /** @format uri */ html_url: string | null; }; /** @description A code security configuration */ @@ -26469,18 +26469,18 @@ export interface components { */ enforcement?: "enforced" | "unenforced"; /** - * Format: uri * @description The URL of the configuration + * @format uri */ url?: string; /** - * Format: uri * @description The URL of the configuration + * @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }; /** @description Feature options for code scanning default setup */ @@ -26508,8 +26508,8 @@ export interface components { */ "simple-repository": { /** - * Format: int64 * @description A unique identifier of the repository. + * @format int64 * @example 1296269 */ id: number; @@ -26532,8 +26532,8 @@ export interface components { /** @description Whether the repository is private. */ private: boolean; /** - * Format: uri * @description The URL to view the repository on GitHub.com. + * @format uri * @example https://github.com/octocat/Hello-World */ html_url: string; @@ -26545,8 +26545,8 @@ export interface components { /** @description Whether the repository is a fork. */ fork: boolean; /** - * Format: uri * @description The URL to get more information about the repository from the GitHub API. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World */ url: string; @@ -26596,32 +26596,32 @@ export interface components { */ contents_url: string; /** - * Format: uri * @description A template for the API URL to list the contributors to the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/contributors */ contributors_url: string; /** - * Format: uri * @description The API URL to list the deployments of the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/deployments */ deployments_url: string; /** - * Format: uri * @description The API URL to list the downloads on the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/downloads */ downloads_url: string; /** - * Format: uri * @description The API URL to list the events of the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/events */ events_url: string; /** - * Format: uri * @description The API URL to list the forks of the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/forks */ forks_url: string; @@ -26666,14 +26666,14 @@ export interface components { */ labels_url: string; /** - * Format: uri * @description The API URL to get information about the languages of the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/languages */ languages_url: string; /** - * Format: uri * @description The API URL to merge branches in the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/merges */ merges_url: string; @@ -26698,8 +26698,8 @@ export interface components { */ releases_url: string; /** - * Format: uri * @description The API URL to list the stargazers on the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/stargazers */ stargazers_url: string; @@ -26709,26 +26709,26 @@ export interface components { */ statuses_url: string; /** - * Format: uri * @description The API URL to list the subscribers on the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/subscribers */ subscribers_url: string; /** - * Format: uri * @description The API URL to subscribe to notifications for this repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/subscription */ subscription_url: string; /** - * Format: uri * @description The API URL to get information about tags on the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/tags */ tags_url: string; /** - * Format: uri * @description The API URL to list the teams on the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/teams */ teams_url: string; @@ -26738,8 +26738,8 @@ export interface components { */ trees_url: string; /** - * Format: uri * @description The API URL to list the hooks on the repository. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/hooks */ hooks_url: string; @@ -26824,60 +26824,60 @@ export interface components { /** @description Links to additional advisory information. */ readonly references: { /** - * Format: uri * @description The URL of the reference. + * @format uri */ readonly url: string; }[]; /** - * Format: date-time * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly withdrawn_at: string | null; }; /** - * Format: uri * @description The REST API URL of the alert resource. + * @format uri */ "alert-url": string; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ "alert-html-url": string; /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-created-at": string; /** - * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-updated-at": string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-dismissed-at": string | null; /** - * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-fixed-at": string | null; /** - * Format: date-time * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ @@ -26935,15 +26935,15 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: null | components["schemas"]["simple-user"]; @@ -26961,8 +26961,8 @@ export interface components { push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: null | components["schemas"]["simple-user"]; /** - * Format: date-time * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: null | components["schemas"]["simple-user"]; @@ -26971,8 +26971,8 @@ export interface components { /** @description An optional comment when requesting a push protection bypass. */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ @@ -26996,9 +26996,9 @@ export interface components { login: string; display_login?: string; gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** @@ -27007,17 +27007,17 @@ export interface components { */ milestone: { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ labels_url: string; @@ -27050,22 +27050,22 @@ export interface components { /** @example 8 */ closed_issues: number; /** - * Format: date-time + * @format date-time * @example 2011-04-10T20:09:31Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2014-03-03T18:58:10Z */ updated_at: string; /** - * Format: date-time + * @format date-time * @example 2013-02-12T13:22:01Z */ closed_at: string | null; /** - * Format: date-time + * @format date-time * @example 2012-10-09T23:39:01Z */ due_on: string | null; @@ -27079,7 +27079,7 @@ export interface components { "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** Reaction Rollup */ "reaction-rollup": { - /** Format: uri */ + /** @format uri */ url: string; total_count: number; "+1": number; @@ -27102,23 +27102,23 @@ export interface components { * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ issue: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue + * @format uri * @example https://api.github.com/repositories/42/issues/1 */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -27153,10 +27153,10 @@ export interface components { * @example registration */ labels: (string | { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ url?: string; name?: string; description?: string | null; @@ -27170,28 +27170,28 @@ export interface components { active_lock_reason?: string | null; comments: number; pull_request?: { - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ diff_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string | null; - /** Format: uri */ + /** @format uri */ url: string | null; }; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; draft?: boolean; closed_by?: null | components["schemas"]["simple-user"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; repository?: components["schemas"]["repository"]; performed_via_github_app?: null | components["schemas"]["integration"]; @@ -27205,15 +27205,15 @@ export interface components { */ "issue-comment": { /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 * @example 42 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment + * @format uri * @example https://api.github.com/repositories/42/issues/comments/1 */ url: string; @@ -27224,20 +27224,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: null | components["schemas"]["simple-user"]; /** - * Format: date-time + * @format date-time * @example 2011-04-14T16:00:49Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-04-14T16:00:49Z */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: null | components["schemas"]["integration"]; @@ -27254,7 +27254,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; org?: components["schemas"]["actor"]; @@ -27272,7 +27272,7 @@ export interface components { }[]; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string | null; }; /** @@ -27332,19 +27332,19 @@ export interface components { * @description Base Gist */ "base-gist": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -27361,15 +27361,15 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; description: string | null; comments: number; comments_enabled?: boolean; user: null | components["schemas"]["simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; @@ -27382,7 +27382,7 @@ export interface components { */ "public-user": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; /** * @description discriminator enum property added by openapi-typescript @@ -27390,26 +27390,26 @@ export interface components { */ user_view_type: "public"; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; following_url: string; gists_url: string; starred_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; events_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; site_admin: boolean; @@ -27417,9 +27417,9 @@ export interface components { company: string | null; blog: string | null; location: string | null; - /** Format: email */ + /** @format email */ email: string | null; - /** Format: email */ + /** @format email */ notification_email?: string | null; hireable: boolean | null; bio: string | null; @@ -27428,9 +27428,9 @@ export interface components { public_gists: number; followers: number; following: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; plan?: { collaborators: number; @@ -27456,14 +27456,14 @@ export interface components { "gist-history": { user?: null | components["schemas"]["simple-user"]; version?: string; - /** Format: date-time */ + /** @format date-time */ committed_at?: string; change_status?: { total?: number; additions?: number; deletions?: number; }; - /** Format: uri */ + /** @format uri */ url?: string; }; /** @@ -27474,12 +27474,12 @@ export interface components { /** @deprecated */ forks?: { id?: string; - /** Format: uri */ + /** @format uri */ url?: string; user?: components["schemas"]["public-user"]; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }[] | null; /** @deprecated */ @@ -27489,19 +27489,19 @@ export interface components { * @description Gist */ fork_of?: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -27513,15 +27513,15 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; description: string | null; comments: number; comments_enabled?: boolean; user: null | components["schemas"]["simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: null | components["schemas"]["simple-user"]; truncated?: boolean; @@ -27573,7 +27573,7 @@ export interface components { /** @example MDExOkdpc3RDb21tZW50MQ== */ node_id: string; /** - * Format: uri + * @format uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ url: string; @@ -27584,12 +27584,12 @@ export interface components { body: string; user: null | components["schemas"]["simple-user"]; /** - * Format: date-time + * @format date-time * @example 2011-04-18T23:23:56Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-04-18T23:23:56Z */ updated_at: string; @@ -27601,7 +27601,7 @@ export interface components { */ "gist-commit": { /** - * Format: uri + * @format uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f */ url: string; @@ -27614,7 +27614,7 @@ export interface components { deletions?: number; }; /** - * Format: date-time + * @format date-time * @example 2010-04-14T02:15:15Z */ committed_at: string; @@ -27659,14 +27659,14 @@ export interface components { /** @example MIT */ spdx_id: string | null; /** - * Format: uri + * @format uri * @example https://api.github.com/licenses/mit */ url: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; /** - * Format: uri + * @format uri * @example http://choosealicense.com/licenses/mit/ */ html_url: string; @@ -27719,12 +27719,12 @@ export interface components { */ "marketplace-listing-plan": { /** - * Format: uri + * @format uri * @example https://api.github.com/marketplace_listing/plans/1313 */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts */ accounts_url: string; @@ -27879,7 +27879,7 @@ export interface components { */ "minimal-repository": { /** - * Format: int64 + * @format int64 * @example 1296269 */ id: number; @@ -27892,7 +27892,7 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World */ html_url: string; @@ -27900,7 +27900,7 @@ export interface components { description: string | null; fork: boolean; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World */ url: string; @@ -27923,27 +27923,27 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ contributors_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ deployments_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ downloads_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/events */ events_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ forks_url: string; @@ -27965,12 +27965,12 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ languages_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ merges_url: string; @@ -27984,29 +27984,29 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ subscribers_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ subscription_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ tags_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ teams_url: string; @@ -28015,7 +28015,7 @@ export interface components { clone_url?: string; mirror_url?: string | null; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ hooks_url: string; @@ -28041,17 +28041,17 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:06:43Z */ pushed_at?: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ created_at?: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:14:43Z */ updated_at?: string | null; @@ -28118,22 +28118,22 @@ export interface components { ignored: boolean; reason: string | null; /** - * Format: date-time + * @format date-time * @example 2012-10-06T21:34:12Z */ created_at: string | null; /** - * Format: uri + * @format uri * @example https://api.github.com/notifications/threads/1/subscription */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/notifications/threads/1 */ thread_url?: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/1 */ repository_url?: string; @@ -28150,17 +28150,17 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github/repos */ repos_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github/events */ events_url: string; @@ -28215,17 +28215,17 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github/repos */ repos_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github/events */ events_url: string; @@ -28246,14 +28246,14 @@ export interface components { /** @example GitHub */ company?: string; /** - * Format: uri + * @format uri * @example https://github.com/blog */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email + * @format email * @example octocat@github.com */ email?: string; @@ -28274,7 +28274,7 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri + * @format uri * @example https://github.com/octocat */ html_url: string; @@ -28296,7 +28296,7 @@ export interface components { */ collaborators?: number | null; /** - * Format: email + * @format email * @example org@example.com */ billing_email?: string | null; @@ -28401,13 +28401,13 @@ export interface components { */ secret_scanning_push_protection_custom_link?: string | null; /** - * Format: date-time + * @format date-time * @example 2008-01-14T04:33:35Z */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ archived_at: string | null; /** * @description Controls whether or not deploy keys may be added and used for repositories in the organization. @@ -28567,8 +28567,8 @@ export interface components { /** @description The public IP ranges when public IP is enabled for the hosted runners. */ public_ips?: components["schemas"]["public-ip"][]; /** - * Format: date-time * @description The time at which the runner was last used, in ISO 8601 format. + * @format date-time * @example 2022-10-09T23:39:01Z */ last_active_on?: string | null; @@ -28781,8 +28781,8 @@ export interface components { */ token: string; /** - * Format: date-time * @description The time this token expires + * @format date-time * @example 2016-07-11T22:14:10Z */ expires_at: string; @@ -28813,9 +28813,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -28823,7 +28823,7 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories */ selected_repositories_url?: string; @@ -28868,14 +28868,14 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time * @example 2019-01-24T22:45:36.000Z */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time * @example 2019-01-24T22:45:36.000Z */ updated_at: string; @@ -28885,7 +28885,7 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/org/variables/USERNAME/repositories */ selected_repositories_url?: string; @@ -28905,8 +28905,8 @@ export interface components { */ "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; /** - * Format: uri * @description The REST API URL for fetching the list of instances for an alert. + * @format uri */ "alert-instances-url": string; /** @@ -29062,7 +29062,7 @@ export interface components { */ codespace: { /** - * Format: int64 + * @format int64 * @example 1 */ id: number; @@ -29096,18 +29096,18 @@ export interface components { */ prebuild: boolean | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. + * @format date-time * @example 2011-01-26T19:01:12Z */ last_used_at: string; @@ -29118,8 +29118,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -29156,33 +29156,33 @@ export interface components { */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; @@ -29202,8 +29202,8 @@ export interface components { */ retention_period_minutes?: number | null; /** - * Format: date-time * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" + * @format date-time * @example 2011-01-26T20:01:12Z */ retention_expires_at?: string | null; @@ -29224,13 +29224,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -29239,8 +29239,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved + * @format uri * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories */ selected_repositories_url?: string; @@ -29339,8 +29339,8 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team + * @format uri * @example https://api.github.com/organizations/1/team/1 */ url: string; @@ -29372,12 +29372,12 @@ export interface components { */ notification_setting?: string; /** - * Format: uri + * @format uri * @example https://github.com/orgs/rails/teams/core */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/1/team/1/repos */ repositories_url: string; @@ -29409,15 +29409,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/orgs/rails/teams/core */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: null | components["schemas"]["team-simple"]; }; @@ -29426,11 +29426,11 @@ export interface components { * @description Group of enterprise owners and/or members */ "enterprise-team": { - /** Format: int64 */ + /** @format int64 */ id: number; name: string; slug: string; - /** Format: uri */ + /** @format uri */ url: string; /** @example disabled | all */ sync_to_organizations: string; @@ -29439,14 +29439,14 @@ export interface components { /** @example Justice League */ group_name?: string | null; /** - * Format: uri + * @format uri * @example https://github.com/enterprises/dc/teams/justice-league */ html_url: string; members_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -29459,26 +29459,26 @@ export interface components { /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ assigning_team?: (null | Record) & (components["schemas"]["team"] | components["schemas"]["enterprise-team"]); /** - * Format: date * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @format date */ pending_cancellation_date?: string | null; /** - * Format: date-time * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @format date-time */ last_activity_at?: string | null; /** @description Last editor that was used by the user for a GitHub Copilot completion. */ last_activity_editor?: string | null; /** - * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @format date-time */ created_at: string; /** - * Format: date-time * @deprecated * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @format date-time */ updated_at?: string; /** @@ -29618,8 +29618,8 @@ export interface components { */ "copilot-usage-metrics-day": { /** - * Format: date * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @format date */ date: string; /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ @@ -29639,8 +29639,8 @@ export interface components { */ "copilot-usage-metrics": { /** - * Format: date * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @format date */ day: string; /** @description The total number of Copilot code completion suggestions shown to users. */ @@ -29689,9 +29689,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -29699,7 +29699,7 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories */ selected_repositories_url?: string; @@ -29756,9 +29756,9 @@ export interface components { visibility: "private" | "public"; owner?: null | components["schemas"]["simple-user"]; repository?: null | components["schemas"]["minimal-repository"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -29766,7 +29766,7 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { - /** Format: int64 */ + /** @format int64 */ id: number; login: string | null; email: string | null; @@ -29791,17 +29791,17 @@ export interface components { /** @example 1 */ id: number; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/octocat/hooks/1 */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/octocat/hooks/1/pings */ ping_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries */ deliveries_url?: string; @@ -29825,12 +29825,12 @@ export interface components { secret?: string; }; /** - * Format: date-time + * @format date-time * @example 2011-09-06T20:39:23Z */ updated_at: string; /** - * Format: date-time + * @format date-time * @example 2011-09-06T17:26:27Z */ created_at: string; @@ -29846,13 +29846,13 @@ export interface components { /** @description The API path's route template */ api_route?: string; /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count?: number; last_rate_limited_timestamp?: string | null; @@ -29865,7 +29865,7 @@ export interface components { "api-insights-subject-stats": { subject_type?: string; subject_name?: string; - /** Format: int64 */ + /** @format int64 */ subject_id?: number; total_request_count?: number; rate_limited_request_count?: number; @@ -29878,13 +29878,13 @@ export interface components { */ "api-insights-summary-stats": { /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count?: number; }; @@ -29894,9 +29894,9 @@ export interface components { */ "api-insights-time-stats": { timestamp?: string; - /** Format: int64 */ + /** @format int64 */ total_request_count?: number; - /** Format: int64 */ + /** @format int64 */ rate_limited_request_count?: number; }[]; /** @@ -29906,11 +29906,11 @@ export interface components { "api-insights-user-stats": { actor_type?: string; actor_name?: string; - /** Format: int64 */ + /** @format int64 */ actor_id?: number; - /** Format: int64 */ + /** @format int64 */ integration_id?: number | null; - /** Format: int64 */ + /** @format int64 */ oauth_application_id?: number | null; total_request_count?: number; rate_limited_request_count?: number; @@ -29932,7 +29932,7 @@ export interface components { /** @example repository */ origin: string; /** - * Format: date-time + * @format date-time * @example 2018-08-17T04:18:39Z */ expires_at: string; @@ -29957,7 +29957,7 @@ export interface components { */ "org-membership": { /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/octocat/memberships/defunkt */ url: string; @@ -29974,7 +29974,7 @@ export interface components { */ role: "admin" | "member" | "billing_manager"; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/octocat */ organization_url: string; @@ -29990,7 +29990,7 @@ export interface components { */ migration: { /** - * Format: int64 + * @format int64 * @example 79 */ id: number; @@ -30010,22 +30010,22 @@ export interface components { /** @description The repositories included in the migration. Only returned for export migrations. */ repositories: components["schemas"]["repository"][]; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/octo-org/migrations/79 */ url: string; /** - * Format: date-time + * @format date-time * @example 2015-07-06T15:33:38-07:00 */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2015-07-06T15:33:38-07:00 */ updated_at: string; node_id: string; - /** Format: uri */ + /** @format uri */ archive_url?: string; /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; @@ -30036,8 +30036,8 @@ export interface components { */ "organization-role": { /** - * Format: int64 * @description The unique identifier of the role. + * @format int64 */ id: number; /** @description The name of the role. */ @@ -30058,13 +30058,13 @@ export interface components { permissions: string[]; organization: null | components["schemas"]["simple-user"]; /** - * Format: date-time * @description The date and time the role was created. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time the role was last updated. + * @format date-time */ updated_at: string; }; @@ -30094,15 +30094,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/orgs/rails/teams/core */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: null | components["schemas"]["team-simple"]; }; @@ -30128,24 +30128,24 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri + * @format uri * @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ gravatar_id: string | null; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/followers */ followers_url: string; @@ -30156,24 +30156,24 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/subscriptions */ subscriptions_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/orgs */ organizations_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/repos */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/received_events */ received_events_url: string; @@ -30210,17 +30210,17 @@ export interface components { license?: string; description?: string; /** - * Format: date-time + * @format date-time * @example 2011-04-10T20:09:31Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2014-03-03T18:58:10Z */ updated_at: string; /** - * Format: date-time + * @format date-time * @example 2014-03-03T18:58:10Z */ deleted_at?: string; @@ -30348,9 +30348,9 @@ export interface components { * @enum {string} */ visibility: "all" | "private" | "selected"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30380,9 +30380,9 @@ export interface components { visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ selected_repository_ids?: number[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30391,22 +30391,22 @@ export interface components { */ project: { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/api-playground/projects-test */ owner_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/projects/1002604 */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/api-playground/projects-test/projects/12 */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/projects/1002604/columns */ columns_url: string; @@ -30433,12 +30433,12 @@ export interface components { state: string; creator: null | components["schemas"]["simple-user"]; /** - * Format: date-time + * @format date-time * @example 2011-04-10T20:09:31Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2014-03-03T18:58:10Z */ updated_at: string; @@ -30458,8 +30458,8 @@ export interface components { /** @description The name of the property */ property_name: string; /** - * Format: uri * @description The URL that can be used to fetch, update, or delete info about this property via the API. + * @format uri */ url?: string; /** @@ -30545,7 +30545,7 @@ export interface components { */ "code-of-conduct-simple": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ url: string; @@ -30554,7 +30554,7 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @format uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ html_url: string | null; @@ -30565,7 +30565,7 @@ export interface components { */ "full-repository": { /** - * Format: int64 + * @format int64 * @example 1296269 */ id: number; @@ -30578,7 +30578,7 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World */ html_url: string; @@ -30586,7 +30586,7 @@ export interface components { description: string | null; fork: boolean; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World */ url: string; @@ -30609,27 +30609,27 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ contributors_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ deployments_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ downloads_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/events */ events_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ forks_url: string; @@ -30652,12 +30652,12 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ languages_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ merges_url: string; @@ -30672,29 +30672,29 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ subscribers_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ subscription_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ tags_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ teams_url: string; @@ -30703,22 +30703,22 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @format uri * @example git:git.example.com/octocat/Hello-World */ mirror_url: string | null; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ hooks_url: string; /** - * Format: uri + * @format uri * @example https://svn.github.com/octocat/Hello-World */ svn_url: string; /** - * Format: uri + * @format uri * @example https://github.com */ homepage: string | null; @@ -30767,17 +30767,17 @@ export interface components { */ visibility?: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:06:43Z */ pushed_at: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:14:43Z */ updated_at: string; @@ -31368,9 +31368,9 @@ export interface components { }; conditions?: (null | (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"])) | components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]; rules?: components["schemas"]["repository-rule"][]; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }; /** @@ -31395,7 +31395,7 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name?: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:06:43Z */ pushed_at?: string; @@ -31432,7 +31432,7 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name?: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:06:43Z */ pushed_at?: string; @@ -31504,13 +31504,13 @@ export interface components { /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ cve_id: string | null; /** - * Format: uri * @description The API URL for the advisory. + * @format uri */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** @description A short summary of the advisory. */ @@ -31541,28 +31541,28 @@ export interface components { */ state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: date-time * @description The date and time of when the advisory was created, in ISO 8601 format. + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string | null; /** - * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string | null; /** - * Format: date-time * @description The date and time of when the advisory was closed, in ISO 8601 format. + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; readonly submission: { @@ -31680,8 +31680,8 @@ export interface components { */ network_settings_ids?: string[]; /** - * Format: date-time * @description The time at which the network configuration was created, in ISO 8601 format. + * @format date-time * @example 2024-04-26T11:31:07Z */ created_on: string | null; @@ -31729,17 +31729,17 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github/repos */ repos_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github/events */ events_url: string; @@ -31760,14 +31760,14 @@ export interface components { /** @example GitHub */ company?: string; /** - * Format: uri + * @format uri * @example https://github.com/blog */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email + * @format email * @example octocat@github.com */ email?: string; @@ -31788,12 +31788,12 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri + * @format uri * @example https://github.com/octocat */ html_url: string; /** - * Format: date-time + * @format date-time * @example 2008-01-14T04:33:35Z */ created_at: string; @@ -31810,7 +31810,7 @@ export interface components { /** @example 8 */ collaborators?: number | null; /** - * Format: email + * @format email * @example org@example.com */ billing_email?: string | null; @@ -31844,9 +31844,9 @@ export interface components { members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ archived_at: string | null; }; /** @@ -31862,13 +31862,13 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team + * @format uri * @example https://api.github.com/organizations/1/team/1 */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/orgs/rails/teams/core */ html_url: string; @@ -31901,7 +31901,7 @@ export interface components { /** @example https://api.github.com/organizations/1/team/1/members{/member} */ members_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/1/team/1/repos */ repositories_url: string; @@ -31911,12 +31911,12 @@ export interface components { /** @example 10 */ repos_count: number; /** - * Format: date-time + * @format date-time * @example 2017-07-14T16:53:42Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2017-08-17T12:37:15Z */ updated_at: string; @@ -31948,19 +31948,19 @@ export interface components { /** @example 0 */ comments_count: number; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments */ comments_url: string; /** - * Format: date-time + * @format date-time * @example 2018-01-25T18:56:31Z */ created_at: string; - /** Format: date-time */ + /** @format date-time */ last_edited_at: string | null; /** - * Format: uri + * @format uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 */ html_url: string; @@ -31982,7 +31982,7 @@ export interface components { */ private: boolean; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/1/team/2343027 */ team_url: string; @@ -31992,12 +31992,12 @@ export interface components { */ title: string; /** - * Format: date-time + * @format date-time * @example 2018-01-25T18:56:31Z */ updated_at: string; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 */ url: string; @@ -32022,19 +32022,19 @@ export interface components { */ body_version: string; /** - * Format: date-time + * @format date-time * @example 2018-01-15T23:53:58Z */ created_at: string; - /** Format: date-time */ + /** @format date-time */ last_edited_at: string | null; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 */ discussion_url: string; /** - * Format: uri + * @format uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 */ html_url: string; @@ -32046,12 +32046,12 @@ export interface components { */ number: number; /** - * Format: date-time + * @format date-time * @example 2018-01-15T23:53:58Z */ updated_at: string; /** - * Format: uri + * @format uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 */ url: string; @@ -32074,7 +32074,7 @@ export interface components { */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** - * Format: date-time + * @format date-time * @example 2016-05-20T20:09:31Z */ created_at: string; @@ -32084,7 +32084,7 @@ export interface components { * @description Team Membership */ "team-membership": { - /** Format: uri */ + /** @format uri */ url: string; /** * @description The role of the user in the team. @@ -32164,7 +32164,7 @@ export interface components { */ private: boolean; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World */ html_url: string; @@ -32172,7 +32172,7 @@ export interface components { description: string | null; fork: boolean; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World */ url: string; @@ -32195,27 +32195,27 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ contributors_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ deployments_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ downloads_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/events */ events_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ forks_url: string; @@ -32238,12 +32238,12 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ languages_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ merges_url: string; @@ -32258,29 +32258,29 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ subscribers_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ subscription_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ tags_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ teams_url: string; @@ -32289,22 +32289,22 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @format uri * @example git:git.example.com/octocat/Hello-World */ mirror_url: string | null; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ hooks_url: string; /** - * Format: uri + * @format uri * @example https://svn.github.com/octocat/Hello-World */ svn_url: string; /** - * Format: uri + * @format uri * @example https://github.com */ homepage: string | null; @@ -32369,17 +32369,17 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:06:43Z */ pushed_at: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ created_at: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:14:43Z */ updated_at: string | null; @@ -32438,13 +32438,13 @@ export interface components { */ "project-card": { /** - * Format: uri + * @format uri * @example https://api.github.com/projects/columns/cards/1478 */ url: string; /** - * Format: int64 * @description The project card's ID + * @format int64 * @example 42 */ id: number; @@ -32454,12 +32454,12 @@ export interface components { note: string | null; creator: null | components["schemas"]["simple-user"]; /** - * Format: date-time + * @format date-time * @example 2016-09-05T14:21:06Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2016-09-05T14:20:22Z */ updated_at: string; @@ -32471,17 +32471,17 @@ export interface components { column_name?: string; project_id?: string; /** - * Format: uri + * @format uri * @example https://api.github.com/projects/columns/367 */ column_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 */ content_url?: string; /** - * Format: uri + * @format uri * @example https://api.github.com/projects/120 */ project_url: string; @@ -32492,17 +32492,17 @@ export interface components { */ "project-column": { /** - * Format: uri + * @format uri * @example https://api.github.com/projects/columns/367 */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/projects/120 */ project_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/projects/columns/367/cards */ cards_url: string; @@ -32519,12 +32519,12 @@ export interface components { */ name: string; /** - * Format: date-time + * @format date-time * @example 2016-09-05T14:18:44Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2016-09-05T14:22:28Z */ updated_at: string; @@ -32589,11 +32589,11 @@ export interface components { archive_download_url: string; /** @description Whether or not the artifact has expired. */ expired: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string | null; - /** Format: date-time */ + /** @format date-time */ expires_at: string | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; workflow_run?: { /** @example 10 */ @@ -32629,12 +32629,12 @@ export interface components { /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ version?: string; /** - * Format: date-time + * @format date-time * @example 2019-01-24T22:45:36.000Z */ last_accessed_at?: string; /** - * Format: date-time + * @format date-time * @example 2019-01-24T22:45:36.000Z */ created_at?: string; @@ -32688,20 +32688,20 @@ export interface components { */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time * @description The time that the job created, in ISO 8601 format. + * @format date-time * @example 2019-08-08T08:00:00-07:00 */ created_at: string; /** - * Format: date-time * @description The time that the job started, in ISO 8601 format. + * @format date-time * @example 2019-08-08T08:00:00-07:00 */ started_at: string; /** - * Format: date-time * @description The time that the job finished, in ISO 8601 format. + * @format date-time * @example 2019-08-08T08:00:00-07:00 */ completed_at: string | null; @@ -32731,14 +32731,14 @@ export interface components { /** @example 1 */ number: number; /** - * Format: date-time * @description The time that the step started, in ISO 8601 format. + * @format date-time * @example 2019-08-08T08:00:00-07:00 */ started_at?: string | null; /** - * Format: date-time * @description The time that the job finished, in ISO 8601 format. + * @format date-time * @example 2019-08-08T08:00:00-07:00 */ completed_at?: string | null; @@ -32803,9 +32803,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** Actions Variable */ @@ -32821,14 +32821,14 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time * @example 2019-01-24T22:45:36.000Z */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time * @example 2019-01-24T22:45:36.000Z */ updated_at: string; @@ -32861,7 +32861,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { - /** Format: int64 */ + /** @format int64 */ id: number; number: number; url: string; @@ -32869,7 +32869,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -32879,7 +32879,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -32904,8 +32904,8 @@ export interface components { */ message: string; /** - * Format: date-time * @description Timestamp of the commit + * @format date-time * @example 2014-08-09T08:02:04+12:00 */ timestamp: string; @@ -32917,8 +32917,8 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's author + * @format email * @example monalisa.octocat@example.com */ email: string; @@ -32931,8 +32931,8 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's committer + * @format email * @example monalisa.octocat@example.com */ email: string; @@ -33008,15 +33008,15 @@ export interface components { html_url: string; /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; actor?: components["schemas"]["simple-user"]; triggering_actor?: components["schemas"]["simple-user"]; /** - * Format: date-time * @description The start time of the latest run. Resets on re-run. + * @format date-time */ run_started_at?: string; /** @@ -33094,14 +33094,14 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url?: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. + * @format date-time * @example 2020-11-23T22:00:40Z */ created_at?: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. + * @format date-time * @example 2020-11-23T22:00:40Z */ updated_at?: string; @@ -33149,8 +33149,8 @@ export interface components { "pending-deployment": { environment: { /** - * Format: int64 * @description The id of the environment. + * @format int64 * @example 56780428 */ id?: number; @@ -33172,8 +33172,8 @@ export interface components { */ wait_timer: number; /** - * Format: date-time * @description The time that the wait timer began. + * @format date-time * @example 2020-11-23T22:00:40Z */ wait_timer_started_at: string | null; @@ -33194,13 +33194,13 @@ export interface components { */ deployment: { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ url: string; /** - * Format: int64 * @description Unique identifier of the deployment + * @format int64 * @example 42 */ id: number; @@ -33232,22 +33232,22 @@ export interface components { description: string | null; creator: null | components["schemas"]["simple-user"]; /** - * Format: date-time + * @format date-time * @example 2012-07-20T01:19:13Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2012-07-20T01:19:13Z */ updated_at: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ statuses_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example */ repository_url: string; @@ -33315,12 +33315,12 @@ export interface components { */ state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; /** - * Format: date-time + * @format date-time * @example 2019-12-06T14:20:20.000Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2019-12-06T14:20:20.000Z */ updated_at: string; @@ -33331,7 +33331,7 @@ export interface components { /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ badge_url: string; /** - * Format: date-time + * @format date-time * @example 2019-12-06T14:20:20.000Z */ deleted_at?: string; @@ -33378,8 +33378,8 @@ export interface components { */ ref: string; /** - * Format: date-time * @description The time when the activity occurred. + * @format date-time * @example 2011-01-26T19:06:43Z */ timestamp: string; @@ -33451,7 +33451,7 @@ export interface components { */ "protected-branch-admin-enforced": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins */ url: string; @@ -33464,7 +33464,7 @@ export interface components { */ "protected-branch-pull-request-review": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions */ url?: string; @@ -33509,17 +33509,17 @@ export interface components { * @description Branch Restriction Policy */ "branch-restriction-policy": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ apps_url: string; users: { login?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -33644,7 +33644,7 @@ export interface components { protection_url?: string; required_signatures?: { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ url: string; @@ -33670,12 +33670,12 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; protected: boolean; protection?: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url?: string; }; /** @@ -33719,17 +33719,17 @@ export interface components { /** @example 124 */ changes: number; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ blob_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ raw_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e */ contents_url: string; @@ -33744,7 +33744,7 @@ export interface components { */ commit: { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ url: string; @@ -33753,18 +33753,18 @@ export interface components { /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ node_id: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments */ comments_url: string; commit: { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ url: string; @@ -33778,7 +33778,7 @@ export interface components { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ sha: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 */ url: string; @@ -33791,12 +33791,12 @@ export interface components { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd */ html_url?: string; @@ -33817,12 +33817,12 @@ export interface components { commit: components["schemas"]["commit"]; _links: { html: string; - /** Format: uri */ + /** @format uri */ self: string; }; protected: boolean; protection: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url: string; /** @example "mas*" */ pattern?: string; @@ -33835,7 +33835,7 @@ export interface components { */ "status-check-policy": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks */ url: string; @@ -33849,7 +33849,7 @@ export interface components { app_id: number | null; }[]; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts */ contexts_url: string; @@ -33859,11 +33859,11 @@ export interface components { * @description Branch protections protect branches */ "protected-branch": { - /** Format: uri */ + /** @format uri */ url: string; required_status_checks?: components["schemas"]["status-check-policy"]; required_pull_request_reviews?: { - /** Format: uri */ + /** @format uri */ url: string; dismiss_stale_reviews?: boolean; require_code_owner_reviews?: boolean; @@ -33874,11 +33874,11 @@ export interface components { */ require_last_push_approval: boolean; dismissal_restrictions?: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; users: components["schemas"]["simple-user"][]; teams: components["schemas"]["team"][]; @@ -33892,7 +33892,7 @@ export interface components { }; required_signatures?: { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ url: string; @@ -33900,7 +33900,7 @@ export interface components { enabled: boolean; }; enforce_admins?: { - /** Format: uri */ + /** @format uri */ url: string; enabled: boolean; }; @@ -33937,7 +33937,7 @@ export interface components { */ "deployment-simple": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ url: string; @@ -33963,22 +33963,22 @@ export interface components { /** @example Deploy request from hubot */ description: string | null; /** - * Format: date-time + * @format date-time * @example 2012-07-20T01:19:13Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2012-07-20T01:19:13Z */ updated_at: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ statuses_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example */ repository_url: string; @@ -34000,8 +34000,8 @@ export interface components { */ "check-run": { /** - * Format: int64 * @description The id of the check. + * @format int64 * @example 21 */ id: number; @@ -34032,12 +34032,12 @@ export interface components { */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time + * @format date-time * @example 2018-05-04T01:14:52Z */ started_at: string | null; /** - * Format: date-time + * @format date-time * @example 2018-05-04T01:14:52Z */ completed_at: string | null; @@ -34046,7 +34046,7 @@ export interface components { summary: string | null; text: string | null; annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; }; /** @@ -34093,7 +34093,7 @@ export interface components { */ "check-suite": { /** - * Format: int64 + * @format int64 * @example 5 */ id: number; @@ -34126,9 +34126,9 @@ export interface components { pull_requests: components["schemas"]["pull-request-minimal"][] | null; app: null | components["schemas"]["integration"]; repository: components["schemas"]["minimal-repository"]; - /** Format: date-time */ + /** @format date-time */ created_at: string | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; head_commit: components["schemas"]["simple-commit"]; latest_check_runs_count: number; @@ -34222,8 +34222,8 @@ export interface components { /** @description The description of an autofix. */ "code-scanning-autofix-description": string | null; /** - * Format: date-time * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-autofix-started-at": string; "code-scanning-autofix": { @@ -34249,18 +34249,21 @@ export interface components { * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ "code-scanning-analysis-sarif-id": string; - /** @description The SHA of the commit to which the analysis you are uploading relates. */ + /** + * @description The SHA of the commit to which the analysis you are uploading relates. + * @pattern ^[0-9a-fA-F]+$ + */ "code-scanning-analysis-commit-sha": string; /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ "code-scanning-analysis-environment": string; /** - * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-analysis-created-at": string; /** - * Format: uri * @description The REST API URL of the analysis resource. + * @format uri */ "code-scanning-analysis-url": string; "code-scanning-analysis": { @@ -34294,13 +34297,13 @@ export interface components { */ "code-scanning-analysis-deletion": { /** - * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation + * @format uri */ readonly next_analysis_url: string | null; /** - * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation + * @format uri */ readonly confirm_delete_url: string | null; }; @@ -34321,18 +34324,18 @@ export interface components { /** @description The size of the CodeQL database file in bytes. */ size: number; /** - * Format: date-time * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** - * Format: uri * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. + * @format uri */ url: string; /** @description The commit SHA of the repository at the time the CodeQL database was created. */ @@ -34368,7 +34371,7 @@ export interface components { /** @example 80 */ stargazers_count: number; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:14:43Z */ updated_at: string | null; @@ -34400,18 +34403,18 @@ export interface components { /** @description The download url for the query pack. */ query_pack_url: string; /** - * Format: date-time * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at?: string; /** - * Format: date-time * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at?: string; /** - * Format: date-time * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + * @format date-time */ completed_at?: string | null; /** @enum {string} */ @@ -34490,8 +34493,8 @@ export interface components { */ query_suite?: "default" | "extended"; /** - * Format: date-time * @description Timestamp of latest configuration update. + * @format date-time * @example 2023-12-06T14:20:20.000Z */ updated_at?: string | null; @@ -34539,6 +34542,7 @@ export interface components { /** * @description The full Git reference, formatted as `refs/heads/`, * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + * @pattern ^refs/(heads|tags|pull)/.*$ * @example refs/heads/main */ "code-scanning-ref-full": string; @@ -34547,8 +34551,8 @@ export interface components { "code-scanning-sarifs-receipt": { id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** - * Format: uri * @description The REST API URL for checking the status of the upload. + * @format uri */ readonly url?: string; }; @@ -34559,8 +34563,8 @@ export interface components { */ processing_status?: "pending" | "complete" | "failed"; /** - * Format: uri * @description The REST API URL for getting the analyses associated with the upload. + * @format uri */ readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ @@ -34642,9 +34646,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -34655,7 +34659,7 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 + * @format int64 * @example 1 */ id: number; @@ -34664,24 +34668,24 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri + * @format uri * @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ gravatar_id: string | null; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/followers */ followers_url: string; @@ -34692,24 +34696,24 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/subscriptions */ subscriptions_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/orgs */ organizations_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/repos */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/received_events */ received_events_url: string; @@ -34734,8 +34738,8 @@ export interface components { */ "repository-invitation": { /** - * Format: int64 * @description Unique identifier of the repository invitation. + * @format int64 * @example 42 */ id: number; @@ -34749,7 +34753,7 @@ export interface components { */ permissions: "read" | "write" | "admin" | "triage" | "maintain"; /** - * Format: date-time + * @format date-time * @example 2016-06-13T14:52:50-05:00 */ created_at: string; @@ -34779,9 +34783,9 @@ export interface components { * @description Commit Comment */ "commit-comment": { - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ url: string; id: number; node_id: string; @@ -34791,9 +34795,9 @@ export interface components { line: number | null; commit_id: string; user: null | components["schemas"]["simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -34839,56 +34843,56 @@ export interface components { */ "pull-request-simple": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; /** - * Format: int64 + * @format int64 * @example 1 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/1347 */ html_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ diff_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ patch_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ issue_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ commits_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ comments_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ statuses_url: string; @@ -34904,7 +34908,7 @@ export interface components { /** @example Please pull these awesome changes */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; @@ -34917,22 +34921,22 @@ export interface components { /** @example too heated */ active_lock_reason?: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ updated_at: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ closed_at: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ merged_at: string | null; @@ -34981,16 +34985,16 @@ export interface components { node_id: string; state: string; context: string; - /** Format: uri */ + /** @format uri */ target_url: string | null; required?: boolean | null; - /** Format: uri */ + /** @format uri */ avatar_url: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -35003,9 +35007,9 @@ export interface components { sha: string; total_count: number; repository: components["schemas"]["minimal-repository"]; - /** Format: uri */ + /** @format uri */ commit_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -35027,9 +35031,9 @@ export interface components { }; /** Community Health File */ "community-health-file": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -35053,7 +35057,7 @@ export interface components { pull_request_template: null | components["schemas"]["community-health-file"]; }; /** - * Format: date-time + * @format date-time * @example 2017-02-28T19:09:29Z */ updated_at: string | null; @@ -35066,27 +35070,27 @@ export interface components { */ "commit-comparison": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/compare/master...topic */ html_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 */ permalink_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff */ diff_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch */ patch_url: string; @@ -35117,13 +35121,13 @@ export interface components { path: string; sha: string; content?: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string | null; - /** Format: uri */ + /** @format uri */ download_url: string | null; entries?: { type: string; @@ -35131,29 +35135,29 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string | null; - /** Format: uri */ + /** @format uri */ download_url: string | null; _links: { - /** Format: uri */ + /** @format uri */ git: string | null; - /** Format: uri */ + /** @format uri */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; _links: { - /** Format: uri */ + /** @format uri */ git: string | null; - /** Format: uri */ + /** @format uri */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -35169,20 +35173,20 @@ export interface components { path: string; content?: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string | null; - /** Format: uri */ + /** @format uri */ download_url: string | null; _links: { - /** Format: uri */ + /** @format uri */ git: string | null; - /** Format: uri */ + /** @format uri */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; @@ -35202,20 +35206,20 @@ export interface components { path: string; content: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string | null; - /** Format: uri */ + /** @format uri */ download_url: string | null; _links: { - /** Format: uri */ + /** @format uri */ git: string | null; - /** Format: uri */ + /** @format uri */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; /** @example "actual/actual.md" */ @@ -35238,20 +35242,20 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string | null; - /** Format: uri */ + /** @format uri */ download_url: string | null; _links: { - /** Format: uri */ + /** @format uri */ git: string | null; - /** Format: uri */ + /** @format uri */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -35265,26 +35269,26 @@ export interface components { * @enum {string} */ type: "submodule"; - /** Format: uri */ + /** @format uri */ submodule_git_url: string; size: number; name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string | null; - /** Format: uri */ + /** @format uri */ download_url: string | null; _links: { - /** Format: uri */ + /** @format uri */ git: string | null; - /** Format: uri */ + /** @format uri */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -35367,26 +35371,26 @@ export interface components { login?: string; id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ avatar_url?: string; gravatar_id?: string | null; - /** Format: uri */ + /** @format uri */ url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; following_url?: string; gists_url?: string; starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; events_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; type: string; site_admin?: boolean; @@ -35442,9 +35446,9 @@ export interface components { * @example MY_ARTIFACTORY_PASSWORD */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -35620,6 +35624,7 @@ export interface components { dependency: { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. + * @pattern ^pkg * @example pkg:/npm/%40actions/http-client@1.0.11 */ package_url?: string; @@ -35692,6 +35697,7 @@ export interface components { sha: string; /** * @description The repository branch that triggered this snapshot. + * @pattern ^refs/ * @example refs/heads/main */ ref: string; @@ -35719,8 +35725,8 @@ export interface components { [key: string]: components["schemas"]["manifest"]; }; /** - * Format: date-time * @description The time at which the snapshot was scanned. + * @format date-time * @example 2020-06-13T14:52:50-05:00 */ scanned: string; @@ -35731,12 +35737,12 @@ export interface components { */ "deployment-status": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; /** - * Format: int64 + * @format int64 * @example 1 */ id: number; @@ -35762,43 +35768,43 @@ export interface components { */ environment: string; /** - * Format: uri * @description Closing down notice: the URL to associate with this status. * @default + * @format uri * @example https://example.com/deployment/42/output */ target_url: string; /** - * Format: date-time + * @format date-time * @example 2012-07-20T01:19:13Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2012-07-20T01:19:13Z */ updated_at: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example/deployments/42 */ deployment_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example */ repository_url: string; /** - * Format: uri * @description The URL for accessing your environment. * @default + * @format uri * @example https://staging.example.com/ */ environment_url: string; /** - * Format: uri * @description The URL to associate with this status. * @default + * @format uri * @example https://example.com/deployment/42/output */ log_url: string; @@ -35822,8 +35828,8 @@ export interface components { */ environment: { /** - * Format: int64 * @description The id of the environment. + * @format int64 * @example 56780428 */ id: number; @@ -35839,14 +35845,14 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. + * @format date-time * @example 2020-11-23T22:00:40Z */ created_at: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. + * @format date-time * @example 2020-11-23T22:00:40Z */ updated_at: string; @@ -36006,7 +36012,7 @@ export interface components { blob: { content: string; encoding: string; - /** Format: uri */ + /** @format uri */ url: string; sha: string; size: number | null; @@ -36024,13 +36030,13 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit + * @format date-time * @example 2014-08-09T08:02:04+12:00 */ date: string; @@ -36048,8 +36054,8 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit + * @format date-time * @example 2014-08-09T08:02:04+12:00 */ date: string; @@ -36075,7 +36081,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -36084,9 +36090,9 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { @@ -36096,7 +36102,7 @@ export interface components { payload: string | null; verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -36106,7 +36112,7 @@ export interface components { "git-ref": { ref: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; object: { type: string; @@ -36115,7 +36121,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; }; @@ -36134,8 +36140,8 @@ export interface components { /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ sha: string; /** - * Format: uri * @description URL for the tag + * @format uri * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ url: string; @@ -36152,7 +36158,7 @@ export interface components { object: { sha: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; }; verification?: components["schemas"]["verification"]; @@ -36163,7 +36169,7 @@ export interface components { */ "git-tree": { sha: string; - /** Format: uri */ + /** @format uri */ url: string; truncated: boolean; /** @@ -36255,32 +36261,32 @@ export interface components { events: string[]; config: components["schemas"]["webhook-config"]; /** - * Format: date-time + * @format date-time * @example 2011-09-06T20:39:23Z */ updated_at: string; /** - * Format: date-time + * @format date-time * @example 2011-09-06T17:26:27Z */ created_at: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test */ test_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings */ ping_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries */ deliveries_url?: string; @@ -36315,13 +36321,13 @@ export interface components { }[]; message?: string; authors_count?: number | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ authors_url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; svn_root?: string; }; @@ -36335,9 +36341,9 @@ export interface components { remote_name: string; email: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ import_url: string; }; /** @@ -36377,10 +36383,10 @@ export interface components { * @description Issue Event Project Card */ "issue-event-project-card": { - /** Format: uri */ + /** @format uri */ url: string; id: number; - /** Format: uri */ + /** @format uri */ project_url: string; project_id: number; column_name: string; @@ -36400,14 +36406,14 @@ export interface components { */ "issue-event": { /** - * Format: int64 + * @format int64 * @example 1 */ id: number; /** @example MDEwOklzc3VlRXZlbnQx */ node_id: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 */ url: string; @@ -36419,7 +36425,7 @@ export interface components { /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ commit_url: string | null; /** - * Format: date-time + * @format date-time * @example 2011-04-14T16:00:49Z */ created_at: string; @@ -36655,10 +36661,10 @@ export interface components { performed_via_github_app: null | components["schemas"]["integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -36680,10 +36686,10 @@ export interface components { performed_via_github_app: null | components["schemas"]["integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -36705,10 +36711,10 @@ export interface components { performed_via_github_app: null | components["schemas"]["integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -36730,10 +36736,10 @@ export interface components { performed_via_github_app: components["schemas"]["integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -36750,16 +36756,16 @@ export interface components { */ label: { /** - * Format: int64 * @description Unique identifier for the label. + * @format int64 * @example 208045946 */ id: number; /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ node_id: string; /** - * Format: uri * @description URL for the label + * @format uri * @example https://api.github.com/repositories/42/labels/bug */ url: string; @@ -36798,8 +36804,8 @@ export interface components { id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment + * @format uri * @example https://api.github.com/repositories/42/issues/comments/1 */ url: string; @@ -36810,20 +36816,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: components["schemas"]["simple-user"]; /** - * Format: date-time + * @format date-time * @example 2011-04-14T16:00:49Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-04-14T16:00:49Z */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: null | components["schemas"]["integration"]; @@ -36836,9 +36842,9 @@ export interface components { "timeline-cross-referenced-event": { event: string; actor?: components["schemas"]["simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; source: { type?: string; @@ -36857,13 +36863,13 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit + * @format date-time * @example 2014-08-09T08:02:04+12:00 */ date: string; @@ -36881,8 +36887,8 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit + * @format date-time * @example 2014-08-09T08:02:04+12:00 */ date: string; @@ -36908,7 +36914,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -36917,9 +36923,9 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { @@ -36929,7 +36935,7 @@ export interface components { payload: string | null; verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -36954,12 +36960,12 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ pull_request_url: string; @@ -36971,7 +36977,7 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** * @description A commit SHA for the review. @@ -36993,14 +36999,14 @@ export interface components { */ url: string; /** - * Format: int64 * @description The ID of the pull request review to which the comment belongs. + * @format int64 * @example 42 */ pull_request_review_id: number | null; /** - * Format: int64 * @description The ID of the pull request review comment. + * @format int64 * @example 1 */ id: number; @@ -37051,24 +37057,24 @@ export interface components { */ body: string; /** - * Format: date-time + * @format date-time * @example 2011-04-14T16:00:49Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-04-14T16:00:49Z */ updated_at: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ html_url: string; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ pull_request_url: string; @@ -37076,21 +37082,21 @@ export interface components { _links: { self: { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ href: string; }; html: { /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ href: string; }; pull_request: { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ href: string; @@ -37243,23 +37249,23 @@ export interface components { path: string; sha: string; size: number; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string | null; - /** Format: uri */ + /** @format uri */ git_url: string | null; - /** Format: uri */ + /** @format uri */ download_url: string | null; type: string; content: string; encoding: string; _links: { - /** Format: uri */ + /** @format uri */ git: string | null; - /** Format: uri */ + /** @format uri */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; license: null | components["schemas"]["license-simple"]; @@ -37294,7 +37300,7 @@ export interface components { * @example www.example.com */ domains: string[]; - /** Format: date */ + /** @format date */ expires_at?: string; }; /** @@ -37303,8 +37309,8 @@ export interface components { */ page: { /** - * Format: uri * @description The API address for accessing this Page resource. + * @format uri * @example https://api.github.com/repos/github/hello-world/pages */ url: string; @@ -37326,8 +37332,8 @@ export interface components { */ protected_domain_state?: "pending" | "verified" | "unverified" | null; /** - * Format: date-time * @description The timestamp when a pending domain becomes unverified. + * @format date-time */ pending_domain_unverified_at?: string | null; /** @@ -37337,8 +37343,8 @@ export interface components { */ custom_404: boolean; /** - * Format: uri * @description The web address the Page can be accessed from. + * @format uri * @example https://example.com */ html_url?: string; @@ -37366,7 +37372,7 @@ export interface components { * @description Page Build */ "page-build": { - /** Format: uri */ + /** @format uri */ url: string; status: string; error: { @@ -37375,9 +37381,9 @@ export interface components { pusher: null | components["schemas"]["simple-user"]; commit: string; duration: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -37386,7 +37392,7 @@ export interface components { */ "page-build-status": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest */ url: string; @@ -37401,20 +37407,20 @@ export interface components { /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ id: number | string; /** - * Format: uri * @description The URI to monitor GitHub Pages deployment status. + * @format uri * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 */ status_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages. + * @format uri * @example hello-world.github.io */ page_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages preview. + * @format uri * @example monalisa-1231a2312sa32-23sda74.drafts.github.io */ preview_url?: string; @@ -37499,56 +37505,56 @@ export interface components { */ "pull-request": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; /** - * Format: int64 + * @format int64 * @example 1 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/1347 */ html_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ diff_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ patch_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ issue_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ commits_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ comments_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ statuses_url: string; @@ -37574,7 +37580,7 @@ export interface components { /** @example Please pull these awesome changes */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; @@ -37587,22 +37593,22 @@ export interface components { /** @example too heated */ active_lock_reason?: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ updated_at: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ closed_at: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ merged_at: string | null; @@ -37692,8 +37698,8 @@ export interface components { */ "pull-request-review": { /** - * Format: int64 * @description Unique identifier of the review + * @format int64 * @example 42 */ id: number; @@ -37708,12 +37714,12 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ pull_request_url: string; @@ -37725,7 +37731,7 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. @@ -37742,17 +37748,17 @@ export interface components { */ "review-comment": { /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; /** - * Format: int64 + * @format int64 * @example 42 */ pull_request_review_id: number | null; /** - * Format: int64 + * @format int64 * @example 10 */ id: number; @@ -37776,22 +37782,22 @@ export interface components { /** @example Great stuff */ body: string; /** - * Format: date-time + * @format date-time * @example 2011-04-14T16:00:49Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-04-14T16:00:49Z */ updated_at: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ pull_request_url: string; @@ -37842,9 +37848,9 @@ export interface components { * @description Data related to a release. */ "release-asset": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ browser_download_url: string; id: number; node_id: string; @@ -37862,9 +37868,9 @@ export interface components { content_type: string; size: number; download_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; uploader: null | components["schemas"]["simple-user"]; }; @@ -37873,16 +37879,16 @@ export interface components { * @description A release. */ release: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ assets_url: string; upload_url: string; - /** Format: uri */ + /** @format uri */ tarball_url: string | null; - /** Format: uri */ + /** @format uri */ zipball_url: string | null; id: number; node_id: string; @@ -37908,9 +37914,9 @@ export interface components { * @example false */ prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ published_at: string | null; author: components["schemas"]["simple-user"]; assets: components["schemas"]["release-asset"][]; @@ -37918,8 +37924,8 @@ export interface components { body_text?: string; mentions_count?: number; /** - * Format: uri * @description The URL of the release discussion. + * @format uri */ discussion_url?: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -37964,15 +37970,15 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: null | components["schemas"]["simple-user"]; @@ -37991,8 +37997,8 @@ export interface components { push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: null | components["schemas"]["simple-user"]; /** - * Format: date-time * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: null | components["schemas"]["simple-user"]; @@ -38001,8 +38007,8 @@ export interface components { /** @description An optional comment when requesting a push protection bypass. */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; /** @@ -38086,8 +38092,8 @@ export interface components { /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ issue_title_url: string; @@ -38095,8 +38101,8 @@ export interface components { /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ "secret-scanning-location-issue-body": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ issue_body_url: string; @@ -38104,8 +38110,8 @@ export interface components { /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ "secret-scanning-location-issue-comment": { /** - * Format: uri * @description The API URL to get the issue comment where the secret was detected. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 */ issue_comment_url: string; @@ -38113,8 +38119,8 @@ export interface components { /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ "secret-scanning-location-discussion-title": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. + * @format uri * @example https://github.com/community/community/discussions/39082 */ discussion_title_url: string; @@ -38122,8 +38128,8 @@ export interface components { /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ "secret-scanning-location-discussion-body": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. + * @format uri * @example https://github.com/community/community/discussions/39082#discussion-4566270 */ discussion_body_url: string; @@ -38131,8 +38137,8 @@ export interface components { /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ "secret-scanning-location-discussion-comment": { /** - * Format: uri * @description The API URL to get the discussion comment where the secret was detected. + * @format uri * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 */ discussion_comment_url: string; @@ -38140,8 +38146,8 @@ export interface components { /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ "secret-scanning-location-pull-request-title": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; @@ -38149,8 +38155,8 @@ export interface components { /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ "secret-scanning-location-pull-request-body": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; @@ -38158,8 +38164,8 @@ export interface components { /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ "secret-scanning-location-pull-request-comment": { /** - * Format: uri * @description The API URL to get the pull request comment where the secret was detected. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 */ pull_request_comment_url: string; @@ -38167,8 +38173,8 @@ export interface components { /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ "secret-scanning-location-pull-request-review": { /** - * Format: uri * @description The API URL to get the pull request review where the secret was detected. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 */ pull_request_review_url: string; @@ -38176,8 +38182,8 @@ export interface components { /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ "secret-scanning-location-pull-request-review-comment": { /** - * Format: uri * @description The API URL to get the pull request review comment where the secret was detected. + * @format uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 */ pull_request_review_comment_url: string; @@ -38199,8 +38205,8 @@ export interface components { "secret-scanning-push-protection-bypass": { reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** - * Format: date-time * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ expire_at?: string | null; /** @description The token type this bypass is for. */ @@ -38213,13 +38219,13 @@ export interface components { /** @description The state of the scan. Either "completed", "running", or "pending" */ status?: string; /** - * Format: date-time * @description The time that the scan was completed. Empty if the scan is running + * @format date-time */ completed_at?: string | null; /** - * Format: date-time * @description The time that the scan was started. Empty if the scan is pending + * @format date-time */ started_at?: string | null; }; @@ -38364,7 +38370,7 @@ export interface components { * @description Stargazer */ stargazer: { - /** Format: date-time */ + /** @format date-time */ starred_at: string; user: null | components["schemas"]["simple-user"]; }; @@ -38435,17 +38441,17 @@ export interface components { ignored: boolean; reason: string | null; /** - * Format: date-time + * @format date-time * @example 2012-10-06T21:34:12Z */ created_at: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example/subscription */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/example */ repository_url: string; @@ -38459,16 +38465,16 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 */ zipball_url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 */ tarball_url: string; @@ -38499,7 +38505,7 @@ export interface components { }; /** Traffic */ traffic: { - /** Format: date-time */ + /** @format date-time */ timestamp: string; uniques: number; count: number; @@ -38571,17 +38577,17 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; repository: components["schemas"]["minimal-repository"]; score: number; file_size?: number; language?: string | null; - /** Format: date-time */ + /** @format date-time */ last_modified_at?: string; /** * @example 73..77 @@ -38595,18 +38601,18 @@ export interface components { * @description Commit Search Result Item */ "commit-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { name: string; email: string; - /** Format: date-time */ + /** @format date-time */ date: string; }; committer: null | components["schemas"]["git-user"]; @@ -38614,10 +38620,10 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification?: components["schemas"]["verification"]; }; @@ -38638,18 +38644,18 @@ export interface components { * @description Issue Search Result Item */ "issue-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; number: number; @@ -38659,7 +38665,7 @@ export interface components { assignees?: components["schemas"]["simple-user"][] | null; user: null | components["schemas"]["simple-user"]; labels: { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; url?: string; @@ -38679,23 +38685,23 @@ export interface components { assignee: null | components["schemas"]["simple-user"]; milestone: null | components["schemas"]["milestone"]; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; pull_request?: { - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ diff_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string | null; - /** Format: uri */ + /** @format uri */ url: string | null; }; body?: string; @@ -38705,7 +38711,7 @@ export interface components { repository?: components["schemas"]["repository"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; performed_via_github_app?: null | components["schemas"]["integration"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -38717,7 +38723,7 @@ export interface components { "label-search-result-item": { id: number; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; name: string; color: string; @@ -38737,19 +38743,19 @@ export interface components { full_name: string; owner: null | components["schemas"]["simple-user"]; private: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; description: string | null; fork: boolean; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ pushed_at: string; - /** Format: uri */ + /** @format uri */ homepage: string | null; size: number; stargazers_count: number; @@ -38760,35 +38766,35 @@ export interface components { master_branch?: string; default_branch: string; score: number; - /** Format: uri */ + /** @format uri */ forks_url: string; keys_url: string; collaborators_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; issue_events_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; assignees_url: string; branches_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; blobs_url: string; git_tags_url: string; git_refs_url: string; trees_url: string; statuses_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; commits_url: string; git_commits_url: string; @@ -38796,10 +38802,10 @@ export interface components { issue_comment_url: string; contents_url: string; compare_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; archive_url: string; - /** Format: uri */ + /** @format uri */ downloads_url: string; issues_url: string; pulls_url: string; @@ -38807,18 +38813,18 @@ export interface components { notifications_url: string; labels_url: string; releases_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; git_url: string; ssh_url: string; clone_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; forks: number; open_issues: number; watchers: number; topics?: string[]; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; has_issues: boolean; has_projects: boolean; @@ -38862,15 +38868,15 @@ export interface components { description: string | null; created_by: string | null; released: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; featured: boolean; curated: boolean; score: number; repository_count?: number | null; - /** Format: uri */ + /** @format uri */ logo_url?: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; related?: { @@ -38896,25 +38902,25 @@ export interface components { */ "user-search-result-item": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; score: number; @@ -38926,13 +38932,13 @@ export interface components { public_gists?: number; followers?: number; following?: number; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; name?: string | null; bio?: string | null; - /** Format: email */ + /** @format email */ email?: string | null; location?: string | null; site_admin: boolean; @@ -38940,7 +38946,7 @@ export interface components { text_matches?: components["schemas"]["search-result-text-matches"]; blog?: string | null; company?: string | null; - /** Format: date-time */ + /** @format date-time */ suspended_at?: string | null; user_view_type?: string; }; @@ -38952,7 +38958,7 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 + * @format int64 * @example 1 */ id: number; @@ -38964,24 +38970,24 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri + * @format uri * @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ gravatar_id: string | null; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat */ url: string; /** - * Format: uri + * @format uri * @example https://github.com/octocat */ html_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/followers */ followers_url: string; @@ -38992,24 +38998,24 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/subscriptions */ subscriptions_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/orgs */ organizations_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/repos */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/users/octocat/received_events */ received_events_url: string; @@ -39025,12 +39031,12 @@ export interface components { /** @example San Francisco */ location: string | null; /** - * Format: email + * @format email * @example octocat@github.com */ email: string | null; /** - * Format: email + * @format email * @example octocat@github.com */ notification_email?: string | null; @@ -39048,12 +39054,12 @@ export interface components { /** @example 0 */ following: number; /** - * Format: date-time + * @format date-time * @example 2008-01-14T04:33:35Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2008-01-14T04:33:35Z */ updated_at: string; @@ -39089,13 +39095,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -39104,8 +39110,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved + * @format uri * @example https://api.github.com/user/secrets/SECRET_NAME/repositories */ selected_repositories_url: string; @@ -39137,8 +39143,8 @@ export interface components { */ state?: string | null; /** - * Format: date-time * @description Completion time of the last export operation + * @format date-time * @example 2021-01-01T19:01:12Z */ completed_at?: string | null; @@ -39174,7 +39180,7 @@ export interface components { */ "codespace-with-full-repository": { /** - * Format: int64 + * @format int64 * @example 1 */ id: number; @@ -39208,18 +39214,18 @@ export interface components { */ prebuild: boolean | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. + * @format date-time * @example 2011-01-26T19:01:12Z */ last_used_at: string; @@ -39230,8 +39236,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -39268,33 +39274,33 @@ export interface components { */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; @@ -39314,8 +39320,8 @@ export interface components { */ retention_period_minutes?: number | null; /** - * Format: date-time * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" + * @format date-time * @example 2011-01-26T20:01:12Z */ retention_expires_at?: string | null; @@ -39326,7 +39332,7 @@ export interface components { */ email: { /** - * Format: email + * @format email * @example octocat@github.com */ email: string; @@ -39343,7 +39349,7 @@ export interface components { */ "gpg-key": { /** - * Format: int64 + * @format int64 * @example 3 */ id: number; @@ -39381,7 +39387,7 @@ export interface components { * } */ subkeys: { - /** Format: int64 */ + /** @format int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -39407,11 +39413,11 @@ export interface components { /** @example true */ can_certify: boolean; /** - * Format: date-time + * @format date-time * @example 2016-03-24T11:31:04-06:00 */ created_at: string; - /** Format: date-time */ + /** @format date-time */ expires_at: string | null; /** @example true */ revoked: boolean; @@ -39423,26 +39429,26 @@ export interface components { */ key: { key: string; - /** Format: int64 */ + /** @format int64 */ id: number; url: string; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; verified: boolean; read_only: boolean; }; /** Marketplace Account */ "marketplace-account": { - /** Format: uri */ + /** @format uri */ url: string; id: number; type: string; node_id?: string; login: string; - /** Format: email */ + /** @format email */ email?: string | null; - /** Format: email */ + /** @format email */ organization_billing_email?: string | null; }; /** @@ -39453,7 +39459,7 @@ export interface components { /** @example monthly */ billing_cycle: string; /** - * Format: date-time + * @format date-time * @example 2017-11-11T00:00:00Z */ next_billing_date: string | null; @@ -39461,12 +39467,12 @@ export interface components { /** @example true */ on_free_trial: boolean; /** - * Format: date-time + * @format date-time * @example 2017-11-11T00:00:00Z */ free_trial_ends_on: string | null; /** - * Format: date-time + * @format date-time * @example 2017-11-02T01:12:12Z */ updated_at: string | null; @@ -39491,7 +39497,7 @@ export interface components { key: string; id: number; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; }; /** @@ -39499,7 +39505,7 @@ export interface components { * @description Starred Repository */ "starred-repository": { - /** Format: date-time */ + /** @format date-time */ starred_at: string; repo: components["schemas"]["repository"]; }; @@ -39570,13 +39576,13 @@ export interface components { /** @description A short description of the enterprise. */ description?: string | null; /** - * Format: uri + * @format uri * @example https://github.com/enterprises/octo-business */ html_url: string; /** - * Format: uri * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -39597,16 +39603,16 @@ export interface components { */ slug: string; /** - * Format: date-time + * @format date-time * @example 2019-01-26T19:01:12Z */ created_at: string | null; /** - * Format: date-time + * @format date-time * @example 2019-01-26T19:14:43Z */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** @@ -39640,17 +39646,17 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github */ url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github/repos */ repos_url: string; /** - * Format: uri + * @format uri * @example https://api.github.com/orgs/github/events */ events_url: string; @@ -39674,8 +39680,8 @@ export interface components { */ "repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 * @example 42 */ id: number; @@ -39705,7 +39711,7 @@ export interface components { */ private: boolean; /** - * Format: uri + * @format uri * @example https://github.com/octocat/Hello-World */ html_url: string; @@ -39713,7 +39719,7 @@ export interface components { description: string | null; fork: boolean; /** - * Format: uri + * @format uri * @example https://api.github.com/repos/octocat/Hello-World */ url: string; @@ -39736,27 +39742,27 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ contributors_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ deployments_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ downloads_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/events */ events_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ forks_url: string; @@ -39779,12 +39785,12 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ languages_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ merges_url: string; @@ -39799,29 +39805,29 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ subscribers_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ subscription_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ tags_url: string; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ teams_url: string; @@ -39830,22 +39836,22 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @format uri * @example git:git.example.com/octocat/Hello-World */ mirror_url: string | null; /** - * Format: uri + * @format uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ hooks_url: string; /** - * Format: uri + * @format uri * @example https://svn.github.com/octocat/Hello-World */ svn_url: string; /** - * Format: uri + * @format uri * @example https://github.com */ homepage: string | null; @@ -39923,17 +39929,17 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:06:43Z */ pushed_at: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:01:12Z */ created_at: string | null; /** - * Format: date-time + * @format date-time * @example 2011-01-26T19:14:43Z */ updated_at: string | null; @@ -40189,7 +40195,7 @@ export interface components { authorized_actors_only: boolean; authorized_dismissal_actors_only: boolean; create_protected?: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; dismiss_stale_reviews_on_push: boolean; id: number; @@ -40223,7 +40229,7 @@ export interface components { /** @enum {string} */ signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; strict_required_status_checks_policy: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @description A suite of checks performed on the code of a given code change */ @@ -40238,7 +40244,7 @@ export interface components { * @enum {string|null} */ conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at?: string; /** @example master */ head_branch?: string | null; @@ -40258,7 +40264,7 @@ export interface components { * @enum {string} */ status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ url?: string; @@ -40271,7 +40277,7 @@ export interface components { app: null | components["schemas"]["integration"]; check_suite: components["schemas"]["simple-check-suite"]; /** - * Format: date-time + * @format date-time * @example 2018-05-04T01:14:52Z */ completed_at: string | null; @@ -40306,7 +40312,7 @@ export interface components { node_id: string; output: { annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; summary: string | null; text: string | null; @@ -40314,7 +40320,7 @@ export interface components { }; pull_requests: components["schemas"]["pull-request-minimal"][]; /** - * Format: date-time + * @format date-time * @example 2018-05-04T01:14:52Z */ started_at: string; @@ -40344,27 +40350,27 @@ export interface components { last_used?: string | null; read_only: boolean; title: string; - /** Format: uri */ + /** @format uri */ url: string; verified: boolean; enabled?: boolean; }; /** Workflow */ webhooks_workflow: { - /** Format: uri */ + /** @format uri */ badge_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; node_id: string; path: string; state: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; webhooks_approver: { @@ -40391,39 +40397,39 @@ export interface components { webhooks_reviewers: { /** User */ reviewer?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @enum {string} */ @@ -40441,40 +40447,40 @@ export interface components { }; /** User */ webhooks_user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40487,7 +40493,7 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; child_comment_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; discussion_id: number; html_url: string; @@ -40505,48 +40511,48 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40560,39 +40566,39 @@ export interface components { answer_chosen_at: string | null; /** User */ answer_chosen_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40605,7 +40611,7 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; category: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -40618,7 +40624,7 @@ export interface components { updated_at: string; }; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; html_url: string; id: number; @@ -40636,7 +40642,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; @@ -40655,44 +40661,44 @@ export interface components { state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; timeline_url?: string; title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40724,47 +40730,47 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; updated_at: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40780,8 +40786,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }; @@ -40825,16 +40831,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: components["schemas"]["integration"]; @@ -40849,52 +40855,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40915,76 +40921,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -40996,19 +41002,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -41020,12 +41026,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -41033,56 +41039,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -41095,9 +41101,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -41107,14 +41113,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -41123,39 +41129,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -41234,19 +41240,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -41260,10 +41266,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -41277,53 +41283,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -41333,56 +41339,56 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -41395,9 +41401,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -41409,76 +41415,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -41490,19 +41496,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -41514,12 +41520,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -41527,56 +41533,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -41589,9 +41595,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -41601,14 +41607,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -41617,39 +41623,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -41728,19 +41734,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -41754,10 +41760,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -41771,92 +41777,92 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; /** User */ webhooks_user_mannequin: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -41922,11 +41928,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -41934,11 +41940,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -41952,12 +41958,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -41967,12 +41973,12 @@ export interface components { privacy?: "open" | "closed" | "secret"; /** @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -41996,56 +42002,56 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone_3: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -42058,9 +42064,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -42068,48 +42074,48 @@ export interface components { * @description The membership between the user and the organization. Not present when the action is `member_invited`. */ webhooks_membership: { - /** Format: uri */ + /** @format uri */ organization_url: string; role: string; state: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42195,47 +42201,47 @@ export interface components { /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42243,95 +42249,95 @@ export interface components { id: number; node_id: string; note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project */ webhooks_project: { /** @description Body of the project */ body: string | null; - /** Format: uri */ + /** @format uri */ columns_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Name of the project */ name: string; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ owner_url: string; /** * @description State of the project; either 'open' or 'closed' * @enum {string} */ state: "open" | "closed"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project Column */ webhooks_project_column: { after_id?: number | null; - /** Format: uri */ + /** @format uri */ cards_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The unique identifier of the project column */ id: number; /** @description Name of the project column */ name: string; node_id: string; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -42347,24 +42353,24 @@ export interface components { description: string | null; public: boolean; /** - * Format: date-time + * @format date-time * @example 2022-04-28T12:00:00Z */ closed_at: string | null; /** - * Format: date-time + * @format date-time * @example 2022-04-28T12:00:00Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2022-04-28T12:00:00Z */ updated_at: string; number: number; short_description: string | null; /** - * Format: date-time + * @format date-time * @example 2022-04-28T12:00:00Z */ deleted_at: string | null; @@ -42372,9 +42378,9 @@ export interface components { }; webhooks_project_changes: { archived_at?: { - /** Format: date-time */ + /** @format date-time */ from?: string | null; - /** Format: date-time */ + /** @format date-time */ to?: string | null; }; }; @@ -42396,17 +42402,17 @@ export interface components { content_type: components["schemas"]["projects-v2-item-content-type"]; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time + * @format date-time * @example 2022-04-28T12:00:00Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2022-04-28T12:00:00Z */ updated_at: string; /** - * Format: date-time + * @format date-time * @example 2022-04-28T12:00:00Z */ archived_at: string | null; @@ -42441,24 +42447,24 @@ export interface components { project_node_id?: string; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time + * @format date-time * @example 2022-04-28T12:00:00Z */ created_at: string; /** - * Format: date-time + * @format date-time * @example 2022-04-28T12:00:00Z */ updated_at: string; /** @enum {string|null} */ status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** - * Format: date + * @format date * @example 2022-04-28 */ start_date?: string; /** - * Format: date + * @format date * @example 2022-04-28 */ target_date?: string; @@ -42524,42 +42530,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -42568,76 +42574,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -42657,39 +42663,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42730,32 +42736,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -42765,28 +42771,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -42815,28 +42821,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -42844,7 +42850,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -42865,55 +42871,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42927,10 +42933,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -42954,26 +42960,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -42990,58 +42996,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -43076,32 +43082,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -43111,28 +43117,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -43161,28 +43167,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -43190,7 +43196,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -43211,55 +43217,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43273,10 +43279,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -43300,26 +43306,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -43336,48 +43342,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -43389,8 +43395,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -43401,43 +43407,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43446,56 +43452,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -43508,61 +43514,61 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -43570,11 +43576,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -43583,12 +43589,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -43596,12 +43602,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; @@ -43609,11 +43615,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -43621,11 +43627,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -43634,12 +43640,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -43647,69 +43653,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43722,17 +43728,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -43746,13 +43752,13 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ @@ -43778,8 +43784,8 @@ export interface components { /** @description The ID of the pull request review to which the comment belongs. */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -43793,7 +43799,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -43814,49 +43820,49 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43866,12 +43872,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -43885,52 +43891,52 @@ export interface components { body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; state: string; - /** Format: date-time */ + /** @format date-time */ submitted_at: string | null; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43942,10 +43948,10 @@ export interface components { */ webhooks_release: { assets: { - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; @@ -43959,103 +43965,103 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** User */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; }[]; - /** Format: uri */ + /** @format uri */ assets_url: string; /** User */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; body: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ published_at: string | null; /** Reactions */ reactions?: { @@ -44068,20 +44074,20 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** @format uri */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ zipball_url: string | null; }; /** @@ -44090,10 +44096,10 @@ export interface components { */ webhooks_release_1: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; @@ -44107,103 +44113,103 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** User */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; /** User */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; body: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ published_at: string | null; /** Reactions */ reactions?: { @@ -44216,20 +44222,20 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** @format uri */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ zipball_url: string | null; }; /** @@ -44244,46 +44250,46 @@ export interface components { dismissed_at?: string; /** User */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** @format uri */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -44306,14 +44312,14 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: null | components["schemas"]["simple-user"]; @@ -44335,8 +44341,8 @@ export interface components { push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: null | components["schemas"]["simple-user"]; /** - * Format: date-time * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: null | components["schemas"]["simple-user"]; @@ -44345,8 +44351,8 @@ export interface components { /** @description An optional comment when requesting a push protection bypass. */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ @@ -44373,7 +44379,7 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; @@ -44419,77 +44425,77 @@ export interface components { privacy_level: string; /** User */ sponsor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** User */ sponsorable: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44538,11 +44544,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -44550,11 +44556,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -44568,12 +44574,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -44586,12 +44592,12 @@ export interface components { * @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -44777,14 +44783,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -44795,39 +44801,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44906,18 +44912,18 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; }; before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The head branch name the changes are on. */ head_branch: string | null; @@ -44928,9 +44934,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -44941,9 +44947,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -44967,7 +44973,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -44978,14 +44984,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; @@ -44995,11 +45001,11 @@ export interface components { * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -45021,14 +45027,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -45039,39 +45045,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45150,18 +45156,18 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; }; before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The head branch name the changes are on. */ head_branch: string | null; @@ -45172,9 +45178,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -45185,9 +45191,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -45211,7 +45217,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -45222,14 +45228,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; @@ -45239,11 +45245,11 @@ export interface components { * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -45265,14 +45271,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -45283,39 +45289,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45394,18 +45400,18 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; }; before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The head branch name the changes are on. */ head_branch: string | null; @@ -45416,9 +45422,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -45429,9 +45435,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -45455,7 +45461,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -45466,14 +45472,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; @@ -45483,11 +45489,11 @@ export interface components { * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -45504,50 +45510,50 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; /** User */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45560,8 +45566,8 @@ export interface components { /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: null; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; /** Alert Instance */ @@ -45616,7 +45622,7 @@ export interface components { /** @description The version of the tool used to detect the alert. */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -45634,50 +45640,50 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string; /** User */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45690,8 +45696,8 @@ export interface components { /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: null; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; /** Alert Instance */ @@ -45753,7 +45759,7 @@ export interface components { /** @description The version of the tool used to detect the alert. */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -45771,8 +45777,8 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string | null; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ @@ -45784,8 +45790,8 @@ export interface components { /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: null; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; instances_url?: string; @@ -45849,7 +45855,7 @@ export interface components { version: string | null; } | null; updated_at?: string | null; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -45867,50 +45873,50 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; /** User */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45923,11 +45929,11 @@ export interface components { /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: null; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ instances_url?: string; /** Alert Instance */ most_recent_instance?: { @@ -45988,7 +45994,7 @@ export interface components { /** @description The version of the tool used to detect the alert. */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -46006,8 +46012,8 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ @@ -46019,8 +46025,8 @@ export interface components { /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: null; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; /** Alert Instance */ @@ -46082,7 +46088,7 @@ export interface components { /** @description The version of the tool used to detect the alert. */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; } | null; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -46102,8 +46108,8 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ @@ -46115,8 +46121,8 @@ export interface components { /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: null; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; /** Alert Instance */ @@ -46171,7 +46177,7 @@ export interface components { /** @description The version of the tool used to detect the alert. */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -46202,7 +46208,7 @@ export interface components { /** @description The SHA of the commit to which the comment applies. */ commit_id: string; created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The ID of the commit comment. */ id: number; @@ -46225,48 +46231,48 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46469,39 +46475,39 @@ export interface components { created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46516,14 +46522,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -46532,39 +46538,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46643,20 +46649,20 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -46669,39 +46675,39 @@ export interface components { workflow_run: { /** User */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46712,7 +46718,7 @@ export interface components { check_suite_url?: string; /** @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; @@ -46786,7 +46792,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -46802,7 +46808,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -46813,14 +46819,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; referenced_workflows?: { @@ -46898,51 +46904,51 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ triggering_actor?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -46957,8 +46963,8 @@ export interface components { /** @description The event that triggered the deployment protection rule. */ event?: string; /** - * Format: uri * @description The URL to review the deployment protection rule. + * @format uri */ deployment_callback_url?: string; deployment?: components["schemas"]["deployment"]; @@ -46995,39 +47001,39 @@ export interface components { workflow_run: { /** User */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47038,7 +47044,7 @@ export interface components { check_suite_url?: string; /** @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; @@ -47113,7 +47119,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -47129,7 +47135,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -47140,14 +47146,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; referenced_workflows?: { @@ -47226,51 +47232,51 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -47303,39 +47309,39 @@ export interface components { workflow_run: { /** User */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47346,7 +47352,7 @@ export interface components { check_suite_url?: string; /** @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; @@ -47420,7 +47426,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -47436,7 +47442,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -47447,14 +47453,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; referenced_workflows?: { @@ -47533,51 +47539,51 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; /** User */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -47596,39 +47602,39 @@ export interface components { reviewers: { /** User */ reviewer?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47651,39 +47657,39 @@ export interface components { workflow_run: { /** User */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47694,7 +47700,7 @@ export interface components { check_suite_url?: string; /** @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; @@ -47768,7 +47774,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -47784,7 +47790,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -47795,14 +47801,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; referenced_workflows?: { @@ -47881,51 +47887,51 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -47937,33 +47943,33 @@ export interface components { /** @enum {string} */ action: "created"; check_run?: { - /** Format: date-time */ + /** @format date-time */ completed_at: string | null; /** * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ + /** @format uri */ details_url: string; external_id: string; /** @description The SHA of the commit that is being checked. */ head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The id of the check. */ id: number; /** @description The name of the check run. */ name: string; node_id: string; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ + /** @format uri */ url: string; } | null; /** @@ -47974,39 +47980,39 @@ export interface components { created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48021,14 +48027,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -48037,39 +48043,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48148,20 +48154,20 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ @@ -48169,51 +48175,51 @@ export interface components { created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ deployment_url: string; /** @description The optional human-readable description added to the status. */ description: string; environment: string; - /** Format: uri */ + /** @format uri */ environment_url?: string; id: number; - /** Format: uri */ + /** @format uri */ log_url?: string; node_id: string; /** @@ -48221,14 +48227,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -48237,39 +48243,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48348,17 +48354,17 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; - /** Format: uri */ + /** @format uri */ repository_url: string; /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ state: string; /** @description The optional link added to the status. */ target_url: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -48371,39 +48377,39 @@ export interface components { workflow_run?: { /** User */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48414,7 +48420,7 @@ export interface components { check_suite_url?: string; /** @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; @@ -48488,7 +48494,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -48504,7 +48510,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -48515,14 +48521,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; referenced_workflows?: { @@ -48600,51 +48606,51 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -48669,7 +48675,7 @@ export interface components { changes: { category: { from: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -48918,32 +48924,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -48953,28 +48959,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -48998,28 +49004,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -49027,59 +49033,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49093,36 +49099,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -49254,8 +49260,8 @@ export interface components { */ action: "created" | "edited"; /** - * Format: uri * @description Points to the HTML wiki page. + * @format uri */ html_url: string; /** @description The name of the page. */ @@ -49451,16 +49457,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: null | components["schemas"]["integration"]; @@ -49475,52 +49481,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49533,76 +49539,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -49614,19 +49620,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -49638,12 +49644,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -49651,56 +49657,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -49713,9 +49719,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -49725,14 +49731,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -49741,39 +49747,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49852,19 +49858,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49878,10 +49884,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49895,53 +49901,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49949,39 +49955,39 @@ export interface components { active_lock_reason?: string | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50005,8 +50011,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -50046,7 +50052,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -50077,76 +50083,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50158,19 +50164,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -50182,12 +50188,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -50195,56 +50201,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50257,9 +50263,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -50269,14 +50275,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -50285,39 +50291,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50396,19 +50402,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -50422,10 +50428,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -50439,53 +50445,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50493,39 +50499,39 @@ export interface components { active_lock_reason?: string | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50549,8 +50555,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -50590,7 +50596,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -50623,76 +50629,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50704,19 +50710,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -50728,12 +50734,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -50741,56 +50747,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50803,9 +50809,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -50815,14 +50821,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -50831,39 +50837,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50942,19 +50948,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -50968,10 +50974,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -50985,53 +50991,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51039,39 +51045,39 @@ export interface components { active_lock_reason?: string | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51095,8 +51101,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -51136,7 +51142,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -51184,76 +51190,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -51265,19 +51271,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -51289,12 +51295,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -51302,56 +51308,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51364,9 +51370,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -51376,14 +51382,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -51392,39 +51398,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51503,19 +51509,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51529,10 +51535,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51546,53 +51552,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51643,7 +51649,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -51677,76 +51683,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -51757,19 +51763,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -51781,12 +51787,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -51794,56 +51800,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51856,9 +51862,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -51868,14 +51874,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -51884,39 +51890,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51995,19 +52001,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -52021,10 +52027,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -52038,53 +52044,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52108,75 +52114,75 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -52187,19 +52193,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ @@ -52211,12 +52217,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -52224,56 +52230,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -52286,9 +52292,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -52298,14 +52304,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -52314,39 +52320,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52425,19 +52431,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -52451,10 +52457,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -52468,53 +52474,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52550,76 +52556,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -52630,19 +52636,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -52654,12 +52660,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -52667,56 +52673,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -52729,9 +52735,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -52741,14 +52747,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -52757,39 +52763,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52868,19 +52874,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -52894,10 +52900,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -52911,53 +52917,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52982,76 +52988,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -53062,19 +53068,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -53086,12 +53092,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -53099,56 +53105,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -53161,9 +53167,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -53173,14 +53179,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -53189,39 +53195,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53300,19 +53306,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -53326,10 +53332,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -53343,53 +53349,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53414,76 +53420,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -53495,19 +53501,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ @@ -53519,12 +53525,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: true; @@ -53533,56 +53539,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -53595,9 +53601,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -53607,14 +53613,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -53623,39 +53629,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53734,19 +53740,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -53760,10 +53766,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -53777,53 +53783,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53847,75 +53853,75 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -53926,19 +53932,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ @@ -53950,12 +53956,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -53963,56 +53969,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -54025,9 +54031,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -54037,14 +54043,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -54053,39 +54059,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54164,19 +54170,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -54190,10 +54196,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -54207,53 +54213,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54277,76 +54283,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -54358,19 +54364,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -54382,12 +54388,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -54395,56 +54401,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -54457,9 +54463,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -54469,14 +54475,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -54485,39 +54491,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54596,19 +54602,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -54622,10 +54628,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -54639,53 +54645,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54718,32 +54724,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -54757,28 +54763,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** @description Whether the repository has discussions enabled. */ has_discussions?: boolean; @@ -54804,28 +54810,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -54833,59 +54839,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54899,36 +54905,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -54949,76 +54955,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -55030,19 +55036,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -55054,12 +55060,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -55067,56 +55073,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -55129,9 +55135,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -55141,14 +55147,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -55157,39 +55163,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55268,19 +55274,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -55294,10 +55300,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -55311,53 +55317,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55392,75 +55398,75 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -55471,19 +55477,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ @@ -55495,12 +55501,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -55508,56 +55514,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -55570,9 +55576,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -55582,14 +55588,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -55598,39 +55604,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55709,19 +55715,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -55735,10 +55741,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -55752,53 +55758,53 @@ export interface components { */ state: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55821,76 +55827,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -55902,19 +55908,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -55926,12 +55932,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** @@ -55939,56 +55945,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -56001,9 +56007,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -56013,14 +56019,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -56029,39 +56035,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56140,19 +56146,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -56166,10 +56172,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -56183,53 +56189,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56262,32 +56268,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -56301,28 +56307,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -56351,28 +56357,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -56380,59 +56386,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56446,36 +56452,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -56534,76 +56540,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -56615,19 +56621,19 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ body: string | null; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ @@ -56639,12 +56645,12 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: false; @@ -56653,56 +56659,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -56715,9 +56721,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; @@ -56727,14 +56733,14 @@ export interface components { * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** @format date-time */ created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** @format uri */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; @@ -56743,39 +56749,39 @@ export interface components { node_id: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56854,19 +56860,19 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -56880,10 +56886,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -56897,53 +56903,53 @@ export interface components { */ state?: "open" | "closed"; state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57230,39 +57236,39 @@ export interface components { scope: "team"; /** User */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57284,39 +57290,39 @@ export interface components { scope: "team" | "organization"; /** User */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57358,7 +57364,7 @@ export interface components { content_type: "json" | "form"; insecure_ssl: string; secret?: string; - /** Format: uri */ + /** @format uri */ url: string; }; created_at: string; @@ -57497,50 +57503,50 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ invitation: { - /** Format: date-time */ + /** @format date-time */ created_at: string; email: string | null; - /** Format: date-time */ + /** @format date-time */ failed_at: string | null; failed_reason: string | null; id: number; - /** Format: uri */ + /** @format uri */ invitation_teams_url: string; /** User */ inviter: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57613,46 +57619,46 @@ export interface components { created_at: string | null; description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57660,39 +57666,39 @@ export interface components { package_version: { /** User */ author?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57712,7 +57718,7 @@ export interface components { tags?: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -57773,7 +57779,7 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; md5: string | null; @@ -57789,45 +57795,45 @@ export interface components { release?: { /** User */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string | null; @@ -57835,7 +57841,7 @@ export interface components { published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; @@ -57848,11 +57854,11 @@ export interface components { version: string; } | null; registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; @@ -57873,46 +57879,46 @@ export interface components { created_at: string; description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57920,39 +57926,39 @@ export interface components { package_version: { /** User */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57964,7 +57970,7 @@ export interface components { tags?: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -57976,7 +57982,7 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; md5: string | null; @@ -57992,45 +57998,45 @@ export interface components { release?: { /** User */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; @@ -58038,11 +58044,11 @@ export interface components { published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - /** Format: uri */ + /** @format uri */ source_url?: string; summary: string; tag_name?: string; @@ -58052,11 +58058,11 @@ export interface components { version: string; }; registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; @@ -58077,45 +58083,45 @@ export interface components { }; /** User */ pusher: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; status: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -58181,9 +58187,9 @@ export interface components { secret?: components["schemas"]["webhook-config-secret"]; url?: components["schemas"]["webhook-config-url"]; }; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ deliveries_url?: string; /** @description Determines what events the hook is triggered for. Default: ['push']. */ events: string[]; @@ -58195,14 +58201,14 @@ export interface components { * @enum {string} */ name: "web"; - /** Format: uri */ + /** @format uri */ ping_url?: string; - /** Format: uri */ + /** @format uri */ test_url?: string; type: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** @description The ID of the webhook that triggered the ping. */ @@ -58258,47 +58264,47 @@ export interface components { /** @description Whether or not the card is archived */ archived: boolean; column_id: number | null; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58306,11 +58312,11 @@ export interface components { id: number; node_id: string; note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; repository?: null | components["schemas"]["repository-webhooks"]; @@ -58349,47 +58355,47 @@ export interface components { /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58397,11 +58403,11 @@ export interface components { id: number; node_id: string; note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } & { after_id: number | null; @@ -58747,15 +58753,15 @@ export interface components { to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; start_date?: { - /** Format: date */ + /** @format date */ from?: string | null; - /** Format: date */ + /** @format date */ to?: string | null; }; target_date?: { - /** Format: date */ + /** @format date */ from?: string | null; - /** Format: date */ + /** @format date */ to?: string | null; }; }; @@ -58786,42 +58792,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -58830,76 +58836,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -58920,39 +58926,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58993,32 +58999,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -59028,28 +59034,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -59078,28 +59084,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -59107,7 +59113,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -59128,55 +59134,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59190,10 +59196,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -59217,26 +59223,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59253,58 +59259,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -59339,32 +59345,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -59374,28 +59380,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -59424,28 +59430,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -59453,7 +59459,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -59474,55 +59480,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59536,10 +59542,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -59563,26 +59569,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59599,48 +59605,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -59652,8 +59658,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -59664,43 +59670,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59709,56 +59715,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -59771,62 +59777,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59834,11 +59840,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59847,12 +59853,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59860,12 +59866,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -59873,11 +59879,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -59885,11 +59891,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59898,12 +59904,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59911,69 +59917,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59994,42 +60000,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -60038,76 +60044,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -60127,39 +60133,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60200,32 +60206,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60235,28 +60241,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60285,28 +60291,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -60314,7 +60320,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -60335,55 +60341,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60397,10 +60403,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -60424,26 +60430,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -60460,58 +60466,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -60546,32 +60552,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60581,28 +60587,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60631,28 +60637,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -60660,7 +60666,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -60681,55 +60687,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60743,10 +60749,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -60770,26 +60776,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -60806,48 +60812,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -60859,8 +60865,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -60871,43 +60877,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60916,56 +60922,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -60978,62 +60984,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61041,11 +61047,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61054,12 +61060,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61067,12 +61073,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -61080,11 +61086,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -61092,11 +61098,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61105,12 +61111,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61118,69 +61124,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61202,42 +61208,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -61246,76 +61252,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -61335,39 +61341,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61408,32 +61414,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -61443,28 +61449,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -61493,28 +61499,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -61522,7 +61528,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -61543,55 +61549,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61605,10 +61611,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -61632,26 +61638,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61668,58 +61674,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -61754,32 +61760,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -61789,28 +61795,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -61839,25 +61845,25 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -61865,7 +61871,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -61886,55 +61892,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61948,10 +61954,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -61975,26 +61981,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62011,48 +62017,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -62064,8 +62070,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -62076,43 +62082,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62121,56 +62127,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -62183,62 +62189,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62246,11 +62252,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62259,12 +62265,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62272,12 +62278,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -62285,11 +62291,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -62297,11 +62303,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62310,12 +62316,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62323,69 +62329,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62443,42 +62449,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -62487,76 +62493,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -62576,39 +62582,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62649,32 +62655,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -62684,28 +62690,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -62734,28 +62740,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -62763,7 +62769,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -62784,55 +62790,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62846,10 +62852,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -62873,26 +62879,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62909,58 +62915,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -62995,32 +63001,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63030,28 +63036,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63080,28 +63086,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -63109,7 +63115,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -63130,55 +63136,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63192,10 +63198,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -63219,26 +63225,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -63255,48 +63261,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -63308,8 +63314,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -63320,43 +63326,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63365,56 +63371,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -63427,62 +63433,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -63490,11 +63496,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -63503,12 +63509,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -63516,12 +63522,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; @@ -63529,11 +63535,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -63541,11 +63547,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -63554,12 +63560,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -63567,69 +63573,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63683,42 +63689,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -63727,76 +63733,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -63816,39 +63822,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63889,32 +63895,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63924,28 +63930,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63974,28 +63980,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -64003,7 +64009,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -64024,55 +64030,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64086,10 +64092,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -64113,26 +64119,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64149,58 +64155,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -64235,32 +64241,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -64270,28 +64276,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -64320,28 +64326,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -64349,7 +64355,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -64370,55 +64376,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64432,10 +64438,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -64459,26 +64465,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64495,48 +64501,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -64548,8 +64554,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -64560,43 +64566,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64605,56 +64611,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -64667,62 +64673,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -64730,11 +64736,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64743,12 +64749,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64756,12 +64762,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; @@ -64769,11 +64775,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -64781,11 +64787,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64794,12 +64800,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64807,69 +64813,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64891,42 +64897,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -64935,76 +64941,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -65024,39 +65030,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65097,32 +65103,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -65132,28 +65138,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65182,28 +65188,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -65211,7 +65217,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -65232,55 +65238,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65294,10 +65300,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -65321,26 +65327,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -65357,58 +65363,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -65443,32 +65449,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -65478,28 +65484,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65528,28 +65534,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -65557,7 +65563,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -65578,55 +65584,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65640,10 +65646,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -65667,26 +65673,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -65703,48 +65709,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -65756,8 +65762,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -65768,43 +65774,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65813,56 +65819,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -65875,62 +65881,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65938,11 +65944,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65951,12 +65957,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -65964,12 +65970,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -65977,11 +65983,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -65989,11 +65995,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -66002,12 +66008,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -66015,69 +66021,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66098,42 +66104,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -66142,76 +66148,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -66231,39 +66237,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66304,32 +66310,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66339,28 +66345,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -66389,28 +66395,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -66418,7 +66424,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -66439,55 +66445,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66501,10 +66507,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -66528,26 +66534,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66564,58 +66570,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -66650,32 +66656,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66685,28 +66691,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -66735,28 +66741,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -66764,7 +66770,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -66785,55 +66791,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66847,10 +66853,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -66874,26 +66880,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66910,48 +66916,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -66963,8 +66969,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -66975,43 +66981,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67020,56 +67026,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -67082,62 +67088,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67145,11 +67151,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67158,12 +67164,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67171,12 +67177,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -67184,11 +67190,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -67196,11 +67202,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67209,12 +67215,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67222,69 +67228,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67352,17 +67358,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -67376,13 +67382,13 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ @@ -67408,8 +67414,8 @@ export interface components { /** @description The ID of the pull request review to which the comment belongs. */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -67423,7 +67429,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -67444,49 +67450,49 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67498,42 +67504,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -67541,76 +67547,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -67630,39 +67636,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67703,32 +67709,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -67738,28 +67744,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -67788,28 +67794,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -67817,7 +67823,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -67838,55 +67844,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67900,10 +67906,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -67927,26 +67933,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67963,52 +67969,52 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -68042,32 +68048,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68077,28 +68083,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68127,28 +68133,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -68156,7 +68162,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -68177,55 +68183,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68239,10 +68245,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -68266,26 +68272,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -68302,48 +68308,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -68355,8 +68361,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -68368,56 +68374,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -68430,60 +68436,60 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68491,11 +68497,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68504,12 +68510,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68517,12 +68523,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -68530,11 +68536,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -68542,11 +68548,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68555,12 +68561,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68568,63 +68574,63 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68644,42 +68650,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -68687,76 +68693,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -68776,39 +68782,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68849,32 +68855,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68884,28 +68890,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68934,28 +68940,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -68963,7 +68969,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -68984,55 +68990,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69046,10 +69052,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -69073,26 +69079,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69109,52 +69115,52 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -69188,32 +69194,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -69223,28 +69229,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -69273,28 +69279,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -69302,7 +69308,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -69323,55 +69329,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69385,10 +69391,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -69412,26 +69418,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69448,48 +69454,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -69501,8 +69507,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -69514,56 +69520,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -69576,60 +69582,60 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -69637,11 +69643,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -69650,12 +69656,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -69663,12 +69669,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; @@ -69676,11 +69682,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -69688,11 +69694,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -69701,12 +69707,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -69714,63 +69720,63 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69791,42 +69797,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -69834,76 +69840,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -69924,39 +69930,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69997,32 +70003,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70032,28 +70038,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70082,28 +70088,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -70111,7 +70117,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -70132,55 +70138,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70194,10 +70200,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -70221,26 +70227,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -70257,52 +70263,52 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -70336,32 +70342,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70371,28 +70377,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70421,28 +70427,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -70450,7 +70456,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -70471,55 +70477,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70533,10 +70539,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -70560,26 +70566,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -70596,48 +70602,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -70649,8 +70655,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -70662,56 +70668,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -70724,60 +70730,60 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -70785,11 +70791,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70798,12 +70804,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70811,12 +70817,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; @@ -70824,11 +70830,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -70836,11 +70842,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70849,12 +70855,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70862,64 +70868,64 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; user_view_type?: string; - /** Format: uri */ + /** @format uri */ url?: string; } | null; }; @@ -70938,42 +70944,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -70981,76 +70987,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -71070,39 +71076,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71143,32 +71149,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -71178,28 +71184,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -71228,28 +71234,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -71257,7 +71263,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -71278,55 +71284,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71340,10 +71346,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -71367,26 +71373,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71403,52 +71409,52 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -71482,32 +71488,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -71517,28 +71523,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -71567,28 +71573,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -71596,7 +71602,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -71617,55 +71623,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71679,10 +71685,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -71706,26 +71712,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71742,48 +71748,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -71795,8 +71801,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -71808,56 +71814,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -71870,60 +71876,60 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71931,11 +71937,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71944,12 +71950,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71957,12 +71963,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -71970,11 +71976,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -71982,11 +71988,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71995,12 +72001,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -72008,63 +72014,63 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72075,12 +72081,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -72094,53 +72100,53 @@ export interface components { body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; /** @enum {string} */ state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ + /** @format date-time */ submitted_at: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72165,42 +72171,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -72208,76 +72214,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -72297,39 +72303,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72370,32 +72376,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72405,28 +72411,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -72450,28 +72456,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -72479,59 +72485,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72545,36 +72551,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -72584,52 +72590,52 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -72663,32 +72669,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72698,28 +72704,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -72743,28 +72749,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -72772,59 +72778,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72838,36 +72844,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -72877,48 +72883,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -72930,8 +72936,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -72943,56 +72949,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -73005,60 +73011,60 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73066,11 +73072,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73079,12 +73085,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73092,12 +73098,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -73105,11 +73111,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -73117,11 +73123,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73130,12 +73136,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73143,63 +73149,63 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73222,42 +73228,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -73266,76 +73272,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -73356,39 +73362,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73429,32 +73435,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -73464,28 +73470,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73514,28 +73520,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -73543,7 +73549,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -73564,55 +73570,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73626,10 +73632,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -73646,26 +73652,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73682,58 +73688,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -73768,32 +73774,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -73803,28 +73809,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73853,28 +73859,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -73882,7 +73888,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -73903,55 +73909,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73965,10 +73971,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -73992,26 +73998,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74028,48 +74034,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -74081,8 +74087,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -74093,43 +74099,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74138,56 +74144,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -74200,62 +74206,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -74263,11 +74269,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -74276,12 +74282,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -74289,12 +74295,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -74302,11 +74308,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -74314,11 +74320,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -74327,12 +74333,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -74340,69 +74346,69 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74410,39 +74416,39 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; /** User */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74460,42 +74466,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -74504,76 +74510,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -74594,39 +74600,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74667,32 +74673,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -74702,28 +74708,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -74752,28 +74758,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -74781,7 +74787,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -74802,55 +74808,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74864,10 +74870,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -74891,26 +74897,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74927,58 +74933,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -75013,32 +75019,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75048,28 +75054,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -75098,28 +75104,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -75127,7 +75133,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -75148,55 +75154,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75210,10 +75216,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -75237,26 +75243,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -75273,48 +75279,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -75326,8 +75332,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -75338,43 +75344,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75383,56 +75389,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -75445,62 +75451,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75508,11 +75514,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75521,12 +75527,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75534,12 +75540,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -75547,11 +75553,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75559,11 +75565,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75572,12 +75578,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75585,69 +75591,69 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75661,11 +75667,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75673,11 +75679,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75686,12 +75692,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75699,12 +75705,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }; @@ -75724,42 +75730,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -75768,76 +75774,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -75858,39 +75864,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75931,32 +75937,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75966,28 +75972,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76016,28 +76022,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -76045,7 +76051,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -76066,55 +76072,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76128,10 +76134,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -76155,26 +76161,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -76191,58 +76197,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -76277,32 +76283,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -76312,28 +76318,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76362,28 +76368,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -76391,7 +76397,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -76412,55 +76418,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76474,10 +76480,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -76501,26 +76507,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -76537,48 +76543,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -76590,8 +76596,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -76602,43 +76608,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76647,56 +76653,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -76709,62 +76715,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76772,11 +76778,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76785,12 +76791,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76798,12 +76804,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -76811,11 +76817,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -76823,11 +76829,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76836,12 +76842,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76849,69 +76855,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76919,39 +76925,39 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; /** User */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76969,42 +76975,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -77013,76 +77019,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -77103,39 +77109,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77176,32 +77182,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -77211,28 +77217,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -77261,28 +77267,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -77290,7 +77296,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -77311,55 +77317,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77373,10 +77379,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -77400,26 +77406,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -77436,58 +77442,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -77522,32 +77528,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -77557,28 +77563,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -77607,28 +77613,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -77636,7 +77642,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -77657,55 +77663,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77719,10 +77725,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -77746,26 +77752,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -77782,48 +77788,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -77835,8 +77841,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -77847,43 +77853,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77892,56 +77898,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -77954,62 +77960,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -78017,11 +78023,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78030,12 +78036,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78043,12 +78049,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; @@ -78056,11 +78062,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -78068,11 +78074,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78081,12 +78087,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78094,69 +78100,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78170,11 +78176,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -78182,11 +78188,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78195,12 +78201,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78208,12 +78214,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -78231,42 +78237,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -78274,76 +78280,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -78363,39 +78369,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78436,32 +78442,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -78471,28 +78477,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -78521,28 +78527,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -78550,7 +78556,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -78571,55 +78577,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78633,10 +78639,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -78660,26 +78666,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78696,52 +78702,52 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -78775,32 +78781,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -78810,28 +78816,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -78860,28 +78866,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -78889,7 +78895,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -78910,55 +78916,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78972,10 +78978,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -78999,26 +79005,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79035,48 +79041,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -79088,8 +79094,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -79101,56 +79107,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -79163,60 +79169,60 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79224,11 +79230,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79237,12 +79243,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79250,12 +79256,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -79263,11 +79269,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -79275,11 +79281,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79288,12 +79294,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79301,63 +79307,63 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79378,42 +79384,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -79421,76 +79427,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -79510,39 +79516,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79583,32 +79589,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79618,28 +79624,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79668,28 +79674,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -79697,59 +79703,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79763,36 +79769,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -79804,52 +79810,52 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -79883,32 +79889,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79918,28 +79924,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79968,28 +79974,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -79997,59 +80003,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80063,36 +80069,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -80104,48 +80110,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -80157,8 +80163,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -80170,56 +80176,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -80232,60 +80238,60 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -80293,11 +80299,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -80306,12 +80312,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -80319,12 +80325,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -80332,11 +80338,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -80344,11 +80350,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -80357,12 +80363,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -80370,63 +80376,63 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80438,17 +80444,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -80462,13 +80468,13 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ @@ -80494,8 +80500,8 @@ export interface components { /** @description The ID of the pull request review to which the comment belongs. */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -80509,7 +80515,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -80530,49 +80536,49 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80592,42 +80598,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -80635,76 +80641,76 @@ export interface components { active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -80724,39 +80730,39 @@ export interface components { commit_title: string; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80797,32 +80803,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -80832,28 +80838,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -80882,28 +80888,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -80911,59 +80917,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80977,36 +80983,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -81018,52 +81024,52 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -81097,32 +81103,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -81132,28 +81138,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -81182,28 +81188,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -81211,59 +81217,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81277,36 +81283,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -81318,48 +81324,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -81371,8 +81377,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -81384,56 +81390,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -81446,60 +81452,60 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -81507,11 +81513,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81520,12 +81526,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81533,12 +81539,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; @@ -81546,11 +81552,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -81558,11 +81564,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81571,12 +81577,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81584,63 +81590,63 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81652,17 +81658,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -81676,13 +81682,13 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ @@ -81708,8 +81714,8 @@ export interface components { /** @description The ID of the pull request review to which the comment belongs. */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -81723,7 +81729,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -81744,49 +81750,49 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81809,42 +81815,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -81853,76 +81859,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -81942,39 +81948,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82015,32 +82021,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -82050,28 +82056,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -82100,28 +82106,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -82129,7 +82135,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -82150,55 +82156,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82212,10 +82218,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -82239,26 +82245,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -82275,58 +82281,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -82361,32 +82367,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -82396,28 +82402,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -82446,28 +82452,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -82475,7 +82481,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -82489,55 +82495,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82551,10 +82557,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -82578,26 +82584,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -82614,48 +82620,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -82667,8 +82673,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -82679,43 +82685,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82724,56 +82730,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -82786,62 +82792,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82849,11 +82855,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82862,12 +82868,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82875,12 +82881,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -82888,11 +82894,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -82900,11 +82906,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82913,12 +82919,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82926,69 +82932,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -83010,42 +83016,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -83054,76 +83060,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -83143,39 +83149,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -83216,32 +83222,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -83251,28 +83257,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -83301,28 +83307,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -83330,7 +83336,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -83351,55 +83357,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -83413,10 +83419,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -83440,26 +83446,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -83476,58 +83482,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -83562,32 +83568,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -83597,28 +83603,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -83647,28 +83653,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -83676,7 +83682,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -83697,55 +83703,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -83759,10 +83765,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -83786,26 +83792,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -83822,48 +83828,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -83875,8 +83881,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -83887,43 +83893,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -83932,56 +83938,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -83994,62 +84000,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -84057,11 +84063,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -84070,12 +84076,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -84083,12 +84089,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -84096,11 +84102,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -84108,11 +84114,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -84121,12 +84127,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -84134,69 +84140,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84218,42 +84224,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -84262,76 +84268,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -84351,39 +84357,39 @@ export interface components { commit_title: string | null; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84424,32 +84430,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -84459,28 +84465,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84509,28 +84515,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -84538,7 +84544,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -84559,55 +84565,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84621,10 +84627,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -84648,26 +84654,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -84684,58 +84690,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -84770,32 +84776,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -84805,28 +84811,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84855,28 +84861,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -84884,7 +84890,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -84898,55 +84904,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84960,10 +84966,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -84987,26 +84993,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -85023,48 +85029,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -85076,8 +85082,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -85088,43 +85094,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85133,56 +85139,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -85195,62 +85201,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -85258,11 +85264,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -85271,12 +85277,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -85284,12 +85290,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; @@ -85297,11 +85303,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -85309,11 +85315,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -85322,12 +85328,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -85335,69 +85341,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85418,42 +85424,42 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -85462,76 +85468,76 @@ export interface components { additions?: number; /** User */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -85551,39 +85557,39 @@ export interface components { commit_title: string; /** User */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85624,32 +85630,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -85659,28 +85665,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -85709,28 +85715,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -85738,7 +85744,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -85759,55 +85765,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85821,10 +85827,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -85848,26 +85854,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -85884,58 +85890,58 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; body: string | null; changed_files?: number; - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -85970,32 +85976,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -86005,28 +86011,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -86055,28 +86061,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -86084,7 +86090,7 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; @@ -86105,55 +86111,55 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -86167,10 +86173,10 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; @@ -86194,26 +86200,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -86230,48 +86236,48 @@ export interface components { sha: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ @@ -86283,8 +86289,8 @@ export interface components { name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; @@ -86295,43 +86301,43 @@ export interface components { mergeable?: boolean | null; mergeable_state?: string; merged?: boolean | null; - /** Format: date-time */ + /** @format date-time */ merged_at: string | null; /** User */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -86340,56 +86346,56 @@ export interface components { * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** @format date-time */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** User */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; description: string | null; - /** Format: date-time */ + /** @format date-time */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -86402,62 +86408,62 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -86465,11 +86471,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -86478,12 +86484,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -86491,12 +86497,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; @@ -86504,11 +86510,11 @@ export interface components { deleted?: boolean; /** @description Description of the team */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; @@ -86516,11 +86522,11 @@ export interface components { parent?: { /** @description Description of the team */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -86529,12 +86535,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -86542,69 +86548,69 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** User */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -86628,9 +86634,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -86641,9 +86647,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -86659,14 +86665,14 @@ export interface components { /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; }[]; @@ -86688,9 +86694,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -86701,9 +86707,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -86719,14 +86725,14 @@ export interface components { /** @description An array of files removed in the commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; } | null; @@ -86737,9 +86743,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ pusher: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email?: string | null; /** @description The git author's name. */ name: string; @@ -86775,32 +86781,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -86814,28 +86820,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -86864,28 +86870,28 @@ export interface components { */ has_discussions: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -86893,59 +86899,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -86959,36 +86965,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -87394,10 +87400,10 @@ export interface components { */ release: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; @@ -87411,96 +87417,96 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** User */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; /** User */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; body: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string | null; @@ -87510,7 +87516,7 @@ export interface components { * @enum {boolean} */ prerelease: true; - /** Format: date-time */ + /** @format date-time */ published_at: string | null; /** Reactions */ reactions?: { @@ -87523,20 +87529,20 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** @format uri */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -87802,65 +87808,65 @@ export interface components { from: { /** Organization */ organization?: { - /** Format: uri */ + /** @format uri */ avatar_url: string; description: string | null; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; - /** Format: uri */ + /** @format uri */ issues_url: string; login: string; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ public_members_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** User */ user?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -87911,47 +87917,47 @@ export interface components { dismissed_at: string; /** User */ dismisser: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; external_identifier: string; - /** Format: uri */ + /** @format uri */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -87995,46 +88001,46 @@ export interface components { dismissed_at?: string; /** User */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** @format uri */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -88137,13 +88143,13 @@ export interface components { */ source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at: string; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at: string; /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ @@ -88210,7 +88216,7 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; @@ -88346,13 +88352,13 @@ export interface components { }; /** status event */ "webhook-status": { - /** Format: uri */ + /** @format uri */ avatar_url?: string | null; /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */ branches: { commit: { sha: string | null; - /** Format: uri */ + /** @format uri */ url: string | null; }; name: string; @@ -88361,48 +88367,48 @@ export interface components { commit: { /** User */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id?: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -88414,9 +88420,9 @@ export interface components { }; comment_count: number; committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -88429,10 +88435,10 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification: { payload: string | null; @@ -88445,53 +88451,53 @@ export interface components { }; /** User */ committer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id?: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; node_id: string; parents: { - /** Format: uri */ + /** @format uri */ html_url: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }[]; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; context: string; @@ -88625,32 +88631,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -88664,28 +88670,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -88709,28 +88715,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -88738,59 +88744,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -88804,36 +88810,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -88878,32 +88884,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -88917,28 +88923,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -88962,28 +88968,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -88991,59 +88997,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -89057,36 +89063,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -89131,32 +89137,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -89170,28 +89176,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -89215,28 +89221,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -89244,59 +89250,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -89310,36 +89316,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -89415,32 +89421,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -89454,28 +89460,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -89499,28 +89505,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -89528,59 +89534,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -89594,36 +89600,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -89668,32 +89674,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -89707,28 +89713,28 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -89752,28 +89758,28 @@ export interface components { */ has_wiki: boolean; homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; /** License */ license: { @@ -89781,59 +89787,59 @@ export interface components { name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** @format uri */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** @format uri */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -89847,36 +89853,36 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; pushed_at: null | number | string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -89919,7 +89925,7 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; completed_at: string | null; /** @enum {string|null} */ @@ -89927,7 +89933,7 @@ export interface components { /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -89936,7 +89942,7 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ runner_group_id: number | null; @@ -89966,7 +89972,7 @@ export interface components { /** @enum {string} */ status: "in_progress" | "completed" | "queued"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; @@ -90009,7 +90015,7 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; completed_at: string | null; /** @enum {string|null} */ @@ -90017,7 +90023,7 @@ export interface components { /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -90026,7 +90032,7 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ runner_group_id: number | null; @@ -90056,7 +90062,7 @@ export interface components { /** @enum {string} */ status: "in_progress" | "completed" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; @@ -90107,14 +90113,14 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; completed_at: string | null; conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -90122,13 +90128,13 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; runner_group_id: number | null; runner_group_name: string | null; runner_id: number | null; runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; @@ -90146,7 +90152,7 @@ export interface components { /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -90161,14 +90167,14 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; completed_at: string | null; conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -90176,13 +90182,13 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; runner_group_id: number | null; runner_group_name: string | null; runner_id: number | null; runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** @description The name of the current branch. */ head_branch: string | null; @@ -90200,7 +90206,7 @@ export interface components { /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -90219,53 +90225,53 @@ export interface components { workflow_run: { /** User */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; /** @enum {string|null} */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string | null; @@ -90276,9 +90282,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -90289,9 +90295,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -90304,143 +90310,143 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; name: string | null; node_id: string; path: string; - /** Format: uri */ + /** @format uri */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -90449,7 +90455,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -90460,14 +90466,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; referenced_workflows?: { @@ -90477,183 +90483,183 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; /** User */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. @@ -90676,52 +90682,52 @@ export interface components { workflow_run: { /** User */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; /** @enum {string|null} */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string | null; @@ -90732,9 +90738,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -90745,9 +90751,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -90760,142 +90766,142 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string | null; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; name: string | null; node_id: string; path: string; - /** Format: uri */ + /** @format uri */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -90904,7 +90910,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -90915,14 +90921,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; referenced_workflows?: { @@ -90932,181 +90938,181 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending"; /** User */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; }; }; @@ -91124,53 +91130,53 @@ export interface components { workflow_run: { /** User */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; /** @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string | null; @@ -91181,9 +91187,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -91194,9 +91200,9 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** @format email */ email: string | null; /** @description The git author's name. */ name: string; @@ -91209,143 +91215,143 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; name: string | null; node_id: string; path: string; - /** Format: uri */ + /** @format uri */ previous_attempt_url: string | null; pull_requests: { base: { @@ -91354,7 +91360,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -91365,14 +91371,14 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; referenced_workflows?: { @@ -91382,183 +91388,183 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; /** User */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; /** User */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; display_title: string; }; @@ -94981,8 +94987,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at?: string; /** @description Whether the notification has been read. */ @@ -96963,7 +96969,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -98404,7 +98413,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; @@ -99098,7 +99110,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -101924,7 +101939,10 @@ export interface operations { registry_type: "maven_repository"; /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ key_id: string; @@ -102061,7 +102079,10 @@ export interface operations { registry_type?: "maven_repository"; /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; @@ -104812,6 +104833,7 @@ export interface operations { "application/json": { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. + * @pattern ^(?:top|bottom|after:\d+)$ * @example bottom */ position: string; @@ -105082,6 +105104,7 @@ export interface operations { "application/json": { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. + * @pattern ^(?:first|last|after:\d+)$ * @example last */ position: string; @@ -107484,7 +107507,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -109601,8 +109627,8 @@ export interface operations { */ status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** - * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @@ -109612,8 +109638,8 @@ export interface operations { */ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -109743,8 +109769,8 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ external_id?: string; /** - * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @@ -109759,8 +109785,8 @@ export interface operations { */ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -110779,15 +110805,15 @@ export interface operations { ref: components["schemas"]["code-scanning-ref-full"]; sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** - * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + * @format uri * @example file:///github/workspace/ */ checkout_uri?: string; /** - * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ @@ -111294,7 +111320,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -112689,7 +112718,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -113771,7 +113803,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -114201,8 +114236,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -114213,8 +114248,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email?: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -114478,8 +114513,8 @@ export interface operations { /** @description The email of the author of the tag */ email: string; /** - * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -117292,8 +117327,8 @@ export interface operations { /** @description A description of the milestone. */ description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on?: string; }; @@ -117397,8 +117432,8 @@ export interface operations { /** @description A description of the milestone. */ description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on?: string; }; @@ -117504,8 +117539,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at?: string; }; @@ -118200,8 +118235,8 @@ export interface operations { /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ head: string; /** - * Format: repo.nwo * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. + * @format repo.nwo * @example octo-org/octo-repo */ head_repo?: string; @@ -118214,8 +118249,8 @@ export interface operations { /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ draft?: boolean; /** - * Format: int64 * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. + * @format int64 * @example 1 */ issue?: number; @@ -123577,7 +123612,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -124705,7 +124743,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. */ + /** + * @description The public SSH key to add to your GitHub account. + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) + */ key: string; }; }; @@ -125928,7 +125969,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** + * @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com + */ key: string; }; }; diff --git a/packages/openapi-typescript/examples/github-api-required.ts b/packages/openapi-typescript/examples/github-api-required.ts index 3bb28b0c1..694863e78 100644 --- a/packages/openapi-typescript/examples/github-api-required.ts +++ b/packages/openapi-typescript/examples/github-api-required.ts @@ -18417,74 +18417,74 @@ export type webhooks = Record; export interface components { schemas: { root: { - /** Format: uri-template */ + /** @format uri-template */ current_user_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_authorizations_html_url: string; - /** Format: uri-template */ + /** @format uri-template */ authorizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ code_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ commit_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ emails_url: string; - /** Format: uri-template */ + /** @format uri-template */ emojis_url: string; - /** Format: uri-template */ + /** @format uri-template */ events_url: string; - /** Format: uri-template */ + /** @format uri-template */ feeds_url: string; - /** Format: uri-template */ + /** @format uri-template */ followers_url: string; - /** Format: uri-template */ + /** @format uri-template */ following_url: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url: string; /** - * Format: uri-template * @deprecated + * @format uri-template */ hub_url?: string; - /** Format: uri-template */ + /** @format uri-template */ issue_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ label_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ public_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ rate_limit_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ topic_search_url?: string; - /** Format: uri-template */ + /** @format uri-template */ user_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_organizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_search_url: string; }; /** @@ -18494,34 +18494,67 @@ export interface components { "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ vulnerability: { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range: string | null; - /** @description The package version that resolves the vulnerability. */ + /** + * @nullable + * @description The package version that resolves the vulnerability. + */ first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ + /** + * @nullable + * @description The functions in the package that are affected by the vulnerability. + */ readonly vulnerable_functions: string[] | null; }; + /** @nullable */ "cvss-severities": { + /** @nullable */ cvss_v3: { - /** @description The CVSS 3 vector string. */ + /** + * @nullable + * @description The CVSS 3 vector string. + */ vector_string: string | null; - /** @description The CVSS 3 score. */ + /** + * @nullable + * @description The CVSS 3 score. + */ readonly score: number | null; } | null; + /** @nullable */ cvss_v4: { - /** @description The CVSS 4 vector string. */ + /** + * @nullable + * @description The CVSS 4 vector string. + */ vector_string: string | null; - /** @description The CVSS 4 score. */ + /** + * @nullable + * @description The CVSS 4 score. + */ readonly score: number | null; } | null; } | null; - /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + /** + * @nullable + * @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). + */ "security-advisory-epss": { percentage: number; percentile: number; @@ -18531,37 +18564,42 @@ export interface components { * @description A GitHub user. */ "simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -18571,25 +18609,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -18609,23 +18647,30 @@ export interface components { "global-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id: string | null; /** @description The API URL for the advisory. */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The API URL for the repository advisory. + * @format uri */ readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ description: string | null; /** * @description The type of advisory. @@ -18638,10 +18683,12 @@ export interface components { */ severity: "critical" | "high" | "medium" | "low" | "unknown"; /** - * Format: uri + * @nullable * @description The URL of the advisory's source code. + * @format uri */ source_code_location: string | null; + /** @nullable */ readonly identifiers: { /** * @description The type of identifier. @@ -18651,50 +18698,68 @@ export interface components { /** @description The identifier value. */ value: string; }[] | null; + /** @nullable */ references: string[] | null; /** - * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + * @format date-time */ readonly github_reviewed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. * This field is only populated when the advisory is imported from the National Vulnerability Database. + * @format date-time */ readonly nvd_published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; - /** @description The products and respective version ranges affected by the advisory. */ + /** + * @nullable + * @description The products and respective version ranges affected by the advisory. + */ vulnerabilities: components["schemas"]["vulnerability"][] | null; + /** @nullable */ cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; epss?: components["schemas"]["security-advisory-epss"]; + /** @nullable */ cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description The users who contributed to the advisory. */ + /** + * @nullable + * @description The users who contributed to the advisory. + */ readonly credits: { user: components["schemas"]["simple-user"]; type: components["schemas"]["security-advisory-credit-types"]; @@ -18724,16 +18789,20 @@ export interface components { * @description An enterprise on GitHub. */ enterprise: { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -18754,20 +18823,23 @@ export interface components { */ slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ integration: { @@ -18791,26 +18863,29 @@ export interface components { * @example Probot Owners */ name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ updated_at: string; /** @@ -18844,15 +18919,18 @@ export interface components { installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; } | null; /** - * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook + * @format uri */ "webhook-config-url": string; /** @@ -18892,9 +18970,9 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z + * @format date-time */ delivered_at: string; /** @@ -18923,24 +19001,28 @@ export interface components { */ event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ throttled_at?: string | null; }; @@ -18949,10 +19031,14 @@ export interface components { * @description Scim Error */ "scim-error": { + /** @nullable */ message: string | null; + /** @nullable */ documentation_url: string | null; + /** @nullable */ detail: string | null; status: number; + /** @nullable */ scimType: string | null; schemas: string[]; }; @@ -18988,9 +19074,9 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z + * @format date-time */ delivered_at: string; /** @@ -19019,24 +19105,28 @@ export interface components { */ event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ throttled_at?: string | null; /** @@ -19045,21 +19135,33 @@ export interface components { */ url?: string; request: { - /** @description The request headers sent with the webhook delivery. */ + /** + * @nullable + * @description The request headers sent with the webhook delivery. + */ headers: { [key: string]: unknown; } | null; - /** @description The webhook payload. */ + /** + * @nullable + * @description The webhook payload. + */ payload: { [key: string]: unknown; } | null; }; response: { - /** @description The response headers received when the delivery was made. */ + /** + * @nullable + * @description The response headers received when the delivery was made. + */ headers: { [key: string]: unknown; } | null; - /** @description The response payload received. */ + /** + * @nullable + * @description The response payload received. + */ payload: string | null; }; }; @@ -19078,8 +19180,8 @@ export interface components { account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; requester: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; }; @@ -19337,40 +19439,46 @@ export interface components { }; /** * Simple User + * @nullable * @description A GitHub user. */ "nullable-simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -19380,25 +19488,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -19419,6 +19527,7 @@ export interface components { * @example 1 */ id: number; + /** @nullable */ account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -19426,18 +19535,18 @@ export interface components { */ repository_selection: "all" | "selected"; /** - * Format: uri * @example https://api.github.com/app/installations/1/access_tokens + * @format uri */ access_tokens_url: string; /** - * Format: uri * @example https://api.github.com/installation/repositories + * @format uri */ repositories_url: string; /** - * Format: uri * @example https://github.com/organizations/github/settings/installations/1 + * @format uri */ html_url: string; /** @example 1 */ @@ -19448,11 +19557,14 @@ export interface components { target_type: string; permissions: components["schemas"]["app-permissions"]; events: string[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -19466,13 +19578,20 @@ export interface components { /** @example github-actions */ app_slug: string; suspended_by: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at: string | null; - /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ + /** + * @nullable + * @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" + */ contact_email?: string | null; }; /** * License Simple + * @nullable * @description License Simple */ "nullable-license-simple": { @@ -19481,15 +19600,19 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; } | null; /** @@ -19498,9 +19621,9 @@ export interface components { */ repository: { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -19528,16 +19651,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -19559,28 +19685,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -19602,13 +19728,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -19622,30 +19748,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -19653,25 +19779,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -19743,18 +19872,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -19872,7 +20004,10 @@ export interface components { */ single_file_paths?: string[]; }; - /** Scoped Installation */ + /** + * Scoped Installation + * @nullable + */ "nullable-scoped-installation": { permissions: components["schemas"]["app-permissions"]; /** @@ -19880,7 +20015,10 @@ export interface components { * @enum {string} */ repository_selection: "all" | "selected"; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -19892,8 +20030,8 @@ export interface components { */ single_file_paths?: string[]; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repositories_url: string; account: components["schemas"]["simple-user"]; @@ -19903,32 +20041,45 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { - /** Format: int64 */ + /** @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ url: string; - /** @description A list of scopes that this authorization is in. */ + /** + * @nullable + * @description A list of scopes that this authorization is in. + */ scopes: string[] | null; token: string; + /** @nullable */ token_last_eight: string | null; + /** @nullable */ hashed_token: string | null; app: { client_id: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; + /** @nullable */ note: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ note_url: string | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; + /** @nullable */ fingerprint: string | null; user?: components["schemas"]["nullable-simple-user"]; installation?: components["schemas"]["nullable-scoped-installation"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; }; /** @@ -19947,9 +20098,9 @@ export interface components { */ full_name: string; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; /** @@ -19977,11 +20128,14 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://github.com/github + * @format uri */ html_url: string; - /** @example Github - Code thigns happen here */ + /** + * @nullable + * @example Github - Code thigns happen here + */ name: string | null; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; @@ -20065,11 +20219,13 @@ export interface components { */ feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ max_teams: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20100,9 +20256,10 @@ export interface components { */ language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ deadline: string | null; starter_code_repository: components["schemas"]["simple-classroom-repository"]; @@ -20118,13 +20275,13 @@ export interface components { /** @example octocat */ login: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; }; @@ -20206,11 +20363,13 @@ export interface components { */ feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ max_teams?: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20241,9 +20400,10 @@ export interface components { */ language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ deadline: string | null; classroom: components["schemas"]["simple-classroom"]; @@ -20320,8 +20480,8 @@ export interface components { /** @example Contributor Covenant */ name: string; /** - * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant + * @format uri */ url: string; /** @@ -20372,7 +20532,10 @@ export interface components { * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). */ body?: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; }; /** @description A code security configuration */ @@ -20423,14 +20586,21 @@ export interface components { * @enum {string} */ code_scanning_default_setup: "enabled" | "disabled" | "not_set"; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ code_scanning_default_setup_options: { /** + * @nullable * @description Whether to use labeled runners or standard GitHub runners. * @enum {string|null} */ runner_type: "standard" | "labeled" | "not_set" | null; - /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning when runner_type is 'labeled'. + */ runner_label: string | null; } | null; /** @@ -20482,28 +20652,34 @@ export interface components { */ enforcement: "enforced" | "unenforced"; /** - * Format: uri * @description The URL of the configuration + * @format uri */ url: string; /** - * Format: uri * @description The URL of the configuration + * @format uri */ html_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ "code-scanning-default-setup-options": { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ runner_type: "standard" | "labeled" | "not_set"; - /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. + */ runner_label: string | null; } | null; /** @description A list of default code security configurations */ @@ -20521,9 +20697,9 @@ export interface components { */ "simple-repository": { /** - * Format: int64 * @description A unique identifier of the repository. * @example 1296269 + * @format int64 */ id: number; /** @@ -20545,12 +20721,13 @@ export interface components { /** @description Whether the repository is private. */ private: boolean; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; /** + * @nullable * @description The repository description. * @example This your first repo! */ @@ -20558,9 +20735,9 @@ export interface components { /** @description Whether the repository is a fork. */ fork: boolean; /** - * Format: uri * @description The URL to get more information about the repository from the GitHub API. * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @@ -20609,33 +20786,33 @@ export interface components { */ contents_url: string; /** - * Format: uri * @description A template for the API URL to list the contributors to the repository. * @example https://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @description The API URL to list the deployments of the repository. * @example https://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @description The API URL to list the downloads on the repository. * @example https://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @description The API URL to list the events of the repository. * @example https://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @description The API URL to list the forks of the repository. * @example https://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @@ -20679,15 +20856,15 @@ export interface components { */ labels_url: string; /** - * Format: uri * @description The API URL to get information about the languages of the repository. * @example https://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @description The API URL to merge branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @@ -20711,9 +20888,9 @@ export interface components { */ releases_url: string; /** - * Format: uri * @description The API URL to list the stargazers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @@ -20722,27 +20899,27 @@ export interface components { */ statuses_url: string; /** - * Format: uri * @description The API URL to list the subscribers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @description The API URL to subscribe to notifications for this repository. * @example https://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @description The API URL to get information about tags on the repository. * @example https://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @description The API URL to list the teams on the repository. * @example https://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @@ -20751,9 +20928,9 @@ export interface components { */ trees_url: string; /** - * Format: uri * @description The API URL to list the hooks on the repository. * @example https://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; }; @@ -20785,7 +20962,10 @@ export interface components { readonly severity: "low" | "medium" | "high" | "critical"; /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ + /** + * @nullable + * @description Details pertaining to the package version that patches this vulnerability. + */ readonly first_patched_version: { /** @description The package version that patches this vulnerability. */ readonly identifier: string; @@ -20795,7 +20975,10 @@ export interface components { "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ + /** + * @nullable + * @description The unique CVE ID assigned to the advisory. + */ readonly cve_id: string | null; /** @description A short, plain text summary of the advisory. */ readonly summary: string; @@ -20812,7 +20995,10 @@ export interface components { readonly cvss: { /** @description The overall CVSS score of the advisory. */ readonly score: number; - /** @description The full CVSS vector string for the advisory. */ + /** + * @nullable + * @description The full CVSS vector string for the advisory. + */ readonly vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -20837,60 +21023,64 @@ export interface components { /** @description Links to additional advisory information. */ readonly references: { /** - * Format: uri * @description The URL of the reference. + * @format uri */ readonly url: string; }[]; /** - * Format: date-time * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly withdrawn_at: string | null; }; /** - * Format: uri * @description The REST API URL of the alert resource. + * @format uri */ "alert-url": string; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ "alert-html-url": string; /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-created-at": string; /** - * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-updated-at": string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-dismissed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-fixed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ @@ -20907,6 +21097,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -20921,19 +21112,24 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time + * @nullable * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "nullable-alert-updated-at": string | null; /** @@ -20942,6 +21138,7 @@ export interface components { */ "secret-scanning-alert-state": "open" | "resolved"; /** + * @nullable * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. * @enum {string|null} */ @@ -20953,15 +21150,16 @@ export interface components { url: components["schemas"]["alert-url"]; html_url: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url: string; state: components["schemas"]["secret-scanning-alert-state"]; resolution: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at: string | null; resolved_by: components["schemas"]["nullable-simple-user"]; @@ -20975,34 +21173,54 @@ export interface components { /** @description The secret that was detected. */ secret: string; repository: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed: boolean | null; push_protection_bypassed_by: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at: string | null; push_protection_bypass_request_reviewer: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url: string | null; - /** @description The comment that was optionally added when this alert was closed */ + /** + * @nullable + * @description The comment that was optionally added when this alert was closed + */ resolution_comment: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ validity: "active" | "inactive" | "unknown"; - /** @description Whether the secret was publicly leaked. */ + /** + * @nullable + * @description Whether the secret was publicly leaked. + */ publicly_leaked: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. + */ multi_repo: boolean | null; }; /** @@ -21013,30 +21231,32 @@ export interface components { id: number; login: string; display_login?: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ "nullable-milestone": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ labels_url: string; /** @example 1002604 */ @@ -21060,7 +21280,10 @@ export interface components { * @example v1.0 */ title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -21068,28 +21291,31 @@ export interface components { /** @example 8 */ closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ due_on: string | null; } | null; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ "nullable-integration": { @@ -21113,26 +21339,29 @@ export interface components { * @example Probot Owners */ name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ updated_at: string; /** @@ -21166,7 +21395,10 @@ export interface components { installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; @@ -21180,7 +21412,7 @@ export interface components { "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** Reaction Rollup */ "reaction-rollup": { - /** Format: uri */ + /** @format uri */ url: string; total_count: number; "+1": number; @@ -21203,23 +21435,23 @@ export interface components { * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ issue: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -21232,6 +21464,7 @@ export interface components { */ state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -21243,6 +21476,7 @@ export interface components { */ title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -21256,45 +21490,67 @@ export interface components { * ] */ labels: (string | { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; name: string; + /** @nullable */ description: string | null; + /** @nullable */ color: string | null; default: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; comments: number; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; draft?: boolean; closed_by?: components["schemas"]["nullable-simple-user"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21308,16 +21564,16 @@ export interface components { */ "issue-comment": { /** - * Format: int64 * @description Unique identifier of the issue comment * @example 42 + * @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ url: string; /** @@ -21327,20 +21583,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21352,12 +21608,13 @@ export interface components { */ event: { id: string; + /** @nullable */ type: string | null; actor: components["schemas"]["actor"]; repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; org?: components["schemas"]["actor"]; @@ -21368,6 +21625,7 @@ export interface components { pages: { page_name: string; title: string; + /** @nullable */ summary: string | null; action: string; sha: string; @@ -21375,7 +21633,10 @@ export interface components { }[]; }; public: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; }; /** @@ -21439,19 +21700,19 @@ export interface components { * @description Base Gist */ "base-gist": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -21468,15 +21729,16 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; + /** @nullable */ description: string | null; comments: number; comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; @@ -21489,7 +21751,7 @@ export interface components { */ "public-user": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; /** * @description discriminator enum property added by openapi-typescript @@ -21497,47 +21759,61 @@ export interface components { */ user_view_type: "public"; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; following_url: string; gists_url: string; starred_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; events_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; site_admin: boolean; + /** @nullable */ name: string | null; + /** @nullable */ company: string | null; + /** @nullable */ blog: string | null; + /** @nullable */ location: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ notification_email?: string | null; + /** @nullable */ hireable: boolean | null; + /** @nullable */ bio: string | null; + /** @nullable */ twitter_username?: string | null; public_repos: number; public_gists: number; followers: number; following: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; plan?: { collaborators: number; @@ -21563,14 +21839,14 @@ export interface components { "gist-history": { user: components["schemas"]["nullable-simple-user"]; version: string; - /** Format: date-time */ + /** @format date-time */ committed_at: string; change_status: { total: number; additions: number; deletions: number; }; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -21578,37 +21854,44 @@ export interface components { * @description Gist Simple */ "gist-simple": { - /** @deprecated */ + /** + * @deprecated + * @nullable + */ forks: { id: string; - /** Format: uri */ + /** @format uri */ url: string; user: components["schemas"]["public-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }[] | null; - /** @deprecated */ + /** + * @deprecated + * @nullable + */ history: components["schemas"]["gist-history"][] | null; /** * Gist + * @nullable * @description Gist */ fork_of: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -21620,15 +21903,16 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; + /** @nullable */ description: string | null; comments: number; comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; @@ -21662,9 +21946,11 @@ export interface components { public: boolean; created_at: string; updated_at: string; + /** @nullable */ description: string | null; comments: number; comments_enabled: boolean; + /** @nullable */ user: string | null; comments_url: string; owner: components["schemas"]["simple-user"]; @@ -21680,8 +21966,8 @@ export interface components { /** @example MDExOkdpc3RDb21tZW50MQ== */ node_id: string; /** - * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + * @format uri */ url: string; /** @@ -21691,13 +21977,13 @@ export interface components { body: string; user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ updated_at: string; author_association: components["schemas"]["author-association"]; @@ -21708,8 +21994,8 @@ export interface components { */ "gist-commit": { /** - * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + * @format uri */ url: string; /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ @@ -21721,8 +22007,8 @@ export interface components { deletions: number; }; /** - * Format: date-time * @example 2010-04-14T02:15:15Z + * @format date-time */ committed_at: string; }; @@ -21764,15 +22050,19 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; }; /** @@ -21784,18 +22074,22 @@ export interface components { key: string; /** @example MIT License */ name: string; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; /** - * Format: uri * @example http://choosealicense.com/licenses/mit/ + * @format uri */ html_url: string; /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ @@ -21857,13 +22151,13 @@ export interface components { */ "marketplace-listing-plan": { /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts + * @format uri */ accounts_url: string; /** @example 1313 */ @@ -21885,6 +22179,7 @@ export interface components { price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; /** @example true */ has_free_trial: boolean; + /** @nullable */ unit_name: string | null; /** @example published */ state: string; @@ -21906,20 +22201,26 @@ export interface components { id: number; login: string; organization_billing_email?: string; + /** @nullable */ email?: string | null; + /** @nullable */ marketplace_pending_change?: { is_installed: boolean; effective_date: string; + /** @nullable */ unit_count: number | null; id: number; plan: components["schemas"]["marketplace-listing-plan"]; } | null; marketplace_purchase: { billing_cycle: string; + /** @nullable */ next_billing_date: string | null; is_installed: boolean; + /** @nullable */ unit_count: number | null; on_free_trial: boolean; + /** @nullable */ free_trial_ends_on: string | null; updated_at: string; plan: components["schemas"]["marketplace-listing-plan"]; @@ -22043,6 +22344,7 @@ export interface components { }; }; }; + /** @nullable */ "security-and-analysis": { advanced_security: { /** @enum {string} */ @@ -22079,8 +22381,8 @@ export interface components { */ "minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -22092,16 +22394,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -22123,28 +22428,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -22165,13 +22470,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -22184,43 +22489,46 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ trees_url: string; clone_url?: string; + /** @nullable */ mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; svn_url?: string; + /** @nullable */ homepage?: string | null; + /** @nullable */ language?: string | null; forks_count?: number; stargazers_count?: number; @@ -22241,18 +22549,21 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at?: string | null; permissions?: { @@ -22269,6 +22580,7 @@ export interface components { subscribers_count?: number; network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ license?: { key: string; name: string; @@ -22303,6 +22615,7 @@ export interface components { reason: string; unread: boolean; updated_at: string; + /** @nullable */ last_read_at: string | null; url: string; /** @example https://api.github.com/notifications/threads/2/subscription */ @@ -22316,25 +22629,27 @@ export interface components { /** @example true */ subscribed: boolean; ignored: boolean; + /** @nullable */ reason: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-06T21:34:12Z + * @format date-time */ created_at: string | null; /** - * Format: uri * @example https://api.github.com/notifications/threads/1/subscription + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/notifications/threads/1 + * @format uri */ thread_url?: string; /** - * Format: uri * @example https://api.github.com/repos/1 + * @format uri */ repository_url?: string; }; @@ -22350,18 +22665,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22374,7 +22689,10 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; }; "billing-usage-report": { @@ -22415,18 +22733,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22439,25 +22757,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -22474,8 +22798,8 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** @example Organization */ @@ -22484,11 +22808,18 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; /** + * @nullable * @description The number of collaborators on private repositories. * * This field may be null if the number of private repositories is over 50,000. @@ -22496,8 +22827,9 @@ export interface components { */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -22507,10 +22839,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -22526,7 +22865,10 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; @@ -22596,18 +22938,22 @@ export interface components { */ secret_scanning_push_protection_custom_link_enabled?: boolean; /** + * @nullable * @description An optional URL string to display to contributors who are blocked from pushing a secret. * @example https://github.com/test-org/test-repo/blob/main/README.md */ secret_scanning_push_protection_custom_link?: string | null; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ archived_at: string | null; /** * @description Controls whether or not deploy keys may be added and used for repositories in the organization. @@ -22644,6 +22990,7 @@ export interface components { }; /** * GitHub-hosted runner image details. + * @nullable * @description Provides details of a hosted runner image */ "nullable-actions-hosted-runner-pool-image": { @@ -22767,9 +23114,10 @@ export interface components { /** @description The public IP ranges when public IP is enabled for the hosted runners. */ public_ips?: components["schemas"]["public-ip"][]; /** - * Format: date-time + * @nullable * @description The time at which the runner was last used, in ISO 8601 format. * @example 2022-10-09T23:39:01Z + * @format date-time */ last_active_on?: string | null; }; @@ -22981,9 +23329,9 @@ export interface components { */ token: string; /** - * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z + * @format date-time */ expires_at: string; /** @@ -22995,7 +23343,10 @@ export interface components { permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file?: string | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -23013,9 +23364,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -23023,8 +23374,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23068,15 +23419,15 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ updated_at: string; /** @@ -23085,14 +23436,17 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/variables/USERNAME/repositories + * @format uri */ selected_repositories_url?: string; }; /** @description The name of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-name": string; - /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + /** + * @nullable + * @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. + */ "code-scanning-analysis-tool-guid": string | null; /** * @description State of a code scanning alert. @@ -23105,33 +23459,43 @@ export interface components { */ "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; /** - * Format: uri * @description The REST API URL for fetching the list of instances for an alert. + * @format uri */ "alert-instances-url": string; /** + * @nullable * @description State of a code scanning alert. * @enum {string|null} */ "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** + * @nullable * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; - /** @description The dismissal comment associated with the dismissal of the alert. */ + /** + * @nullable + * @description The dismissal comment associated with the dismissal of the alert. + */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ id: string | null; /** @description The name of the rule used to detect the alert. */ name: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -23140,14 +23504,26 @@ export interface components { description: string; /** @description A description of the rule used to detect the alert. */ full_description: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ tags: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ help: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri: string | null; }; - /** @description The version of the tool used to generate the code scanning analysis. */ + /** + * @nullable + * @description The version of the tool used to generate the code scanning analysis. + */ "code-scanning-analysis-tool-version": string | null; "code-scanning-analysis-tool": { name: components["schemas"]["code-scanning-analysis-tool-name"]; @@ -23174,6 +23550,7 @@ export interface components { end_column: number; }; /** + * @nullable * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ @@ -23216,6 +23593,7 @@ export interface components { }; /** * Codespace machine + * @nullable * @description A description of the machine powering a codespace. */ "nullable-codespace-machine": { @@ -23250,6 +23628,7 @@ export interface components { */ cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -23262,8 +23641,8 @@ export interface components { */ codespace: { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -23272,11 +23651,13 @@ export interface components { */ name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -23286,29 +23667,31 @@ export interface components { repository: components["schemas"]["minimal-repository"]; machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ last_used_at: string; /** @@ -23318,8 +23701,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -23351,63 +23734,81 @@ export interface components { */ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ allowed_port_privacy_settings: string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ retention_expires_at?: string | null; /** + * @nullable * @description The text to display to a user when a codespace has been stopped for a potentially actionable reason. * @example you've used 100% of your spending limit for Codespaces */ @@ -23424,13 +23825,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -23439,9 +23840,9 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23528,6 +23929,7 @@ export interface components { }; /** * Organization Simple + * @nullable * @description A GitHub organization. */ "nullable-organization-simple": { @@ -23538,18 +23940,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -23562,11 +23964,15 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; } | null; /** * Team Simple + * @nullable * @description Groups of organization members that gives permissions on specified repositories. */ "nullable-team-simple": { @@ -23578,9 +23984,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -23591,6 +23997,7 @@ export interface components { */ name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -23611,13 +24018,13 @@ export interface components { */ notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; /** @example justice-league */ @@ -23637,6 +24044,7 @@ export interface components { node_id: string; name: string; slug: string; + /** @nullable */ description: string | null; privacy?: string; notification_setting?: string; @@ -23648,15 +24056,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; @@ -23665,27 +24073,33 @@ export interface components { * @description Group of enterprise owners and/or members */ "enterprise-team": { - /** Format: int64 */ + /** @format int64 */ id: number; name: string; slug: string; - /** Format: uri */ + /** @format uri */ url: string; /** @example disabled | all */ sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + /** + * @nullable + * @example 62ab9291-fae2-468e-974b-7e45096d5021 + */ group_id?: string | null; - /** @example Justice League */ + /** + * @nullable + * @example Justice League + */ group_name?: string | null; /** - * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league + * @format uri */ html_url: string; members_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -23695,29 +24109,37 @@ export interface components { "copilot-seat-details": { assignee: components["schemas"]["simple-user"]; organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + /** + * @nullable + * @description The team through which the assignee is granted access to GitHub Copilot, if applicable. + */ assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** - * Format: date + * @nullable * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @format date */ pending_cancellation_date?: string | null; /** - * Format: date-time + * @nullable * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @format date-time */ last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + /** + * @nullable + * @description Last editor that was used by the user for a GitHub Copilot completion. + */ last_activity_editor?: string | null; /** - * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @format date-time */ created_at: string; /** - * Format: date-time * @deprecated * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @format date-time */ updated_at?: string; /** @@ -23726,7 +24148,10 @@ export interface components { */ plan_type?: "business" | "enterprise" | "unknown"; }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot editor code completions in the IDE. + */ "copilot-ide-code-completions": ({ /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ total_engaged_users: number; @@ -23748,7 +24173,10 @@ export interface components { name: string; /** @description Indicates whether a model is custom or default. */ is_custom_model: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date: string | null; /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ total_engaged_users: number; @@ -23774,7 +24202,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in the IDE. + */ "copilot-ide-chat": ({ /** @description Total number of users who prompted Copilot Chat in the IDE. */ total_engaged_users: number; @@ -23789,7 +24220,10 @@ export interface components { name: string; /** @description Indicates whether a model is custom or default. */ is_custom_model: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date: string | null; /** @description The number of users who prompted Copilot Chat in the given editor and model. */ total_engaged_users: number; @@ -23804,7 +24238,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in github.com + */ "copilot-dotcom-chat": ({ /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ total_engaged_users: number; @@ -23814,7 +24251,10 @@ export interface components { name: string; /** @description Indicates whether a model is custom or default. */ is_custom_model: boolean; - /** @description The training date for the custom model (if applicable). */ + /** + * @nullable + * @description The training date for the custom model (if applicable). + */ custom_model_training_date: string | null; /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ total_engaged_users: number; @@ -23824,7 +24264,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot for pull requests. */ + /** + * @nullable + * @description Usage metrics for Copilot for pull requests. + */ "copilot-dotcom-pull-requests": ({ /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ total_engaged_users: number; @@ -23840,7 +24283,10 @@ export interface components { name: string; /** @description Indicates whether a model is custom or default. */ is_custom_model: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date: string | null; /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ total_pr_summaries_created: number; @@ -23857,8 +24303,8 @@ export interface components { */ "copilot-usage-metrics-day": { /** - * Format: date * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @format date */ date: string; /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ @@ -23878,8 +24324,8 @@ export interface components { */ "copilot-usage-metrics": { /** - * Format: date * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @format date */ day: string; /** @description The total number of Copilot code completion suggestions shown to users. */ @@ -23898,7 +24344,10 @@ export interface components { total_chat_turns?: number; /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ + /** + * @nullable + * @description Breakdown of Copilot code completions usage by language and editor + */ breakdown: ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ language: string; @@ -23928,9 +24377,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -23938,8 +24387,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23961,12 +24410,13 @@ export interface components { }; /** * Minimal Repository + * @nullable * @description Minimal Repository */ "nullable-minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -23978,16 +24428,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -24009,28 +24462,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -24051,13 +24504,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -24070,43 +24523,46 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ trees_url: string; clone_url?: string; + /** @nullable */ mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; svn_url?: string; + /** @nullable */ homepage?: string | null; + /** @nullable */ language?: string | null; forks_count?: number; stargazers_count?: number; @@ -24127,18 +24583,21 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at?: string | null; permissions?: { @@ -24155,6 +24614,7 @@ export interface components { subscribers_count?: number; network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ license?: { key: string; name: string; @@ -24209,9 +24669,9 @@ export interface components { visibility: "private" | "public"; owner?: components["schemas"]["nullable-simple-user"]; repository?: components["schemas"]["nullable-minimal-repository"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24219,13 +24679,17 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { - /** Format: int64 */ + /** @format int64 */ id: number; + /** @nullable */ login: string | null; + /** @nullable */ email: string | null; role: string; created_at: string; + /** @nullable */ failed_at?: string | null; + /** @nullable */ failed_reason?: string | null; inviter: components["schemas"]["simple-user"]; team_count: number; @@ -24244,18 +24708,18 @@ export interface components { /** @example 1 */ id: number; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings + * @format uri */ ping_url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries + * @format uri */ deliveries_url?: string; /** @example web */ @@ -24280,13 +24744,13 @@ export interface components { secret: string; }; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ created_at: string; type: string; @@ -24301,15 +24765,16 @@ export interface components { /** @description The API path's route template */ api_route: string; /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count: number; + /** @nullable */ last_rate_limited_timestamp: string | null; last_request_timestamp: string; }[]; @@ -24320,10 +24785,11 @@ export interface components { "api-insights-subject-stats": { subject_type: string; subject_name: string; - /** Format: int64 */ + /** @format int64 */ subject_id: number; total_request_count: number; rate_limited_request_count: number; + /** @nullable */ last_rate_limited_timestamp: string | null; last_request_timestamp: string; }[]; @@ -24333,13 +24799,13 @@ export interface components { */ "api-insights-summary-stats": { /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count: number; }; @@ -24349,9 +24815,9 @@ export interface components { */ "api-insights-time-stats": { timestamp: string; - /** Format: int64 */ + /** @format int64 */ total_request_count: number; - /** Format: int64 */ + /** @format int64 */ rate_limited_request_count: number; }[]; /** @@ -24361,14 +24827,21 @@ export interface components { "api-insights-user-stats": { actor_type: string; actor_name: string; - /** Format: int64 */ + /** @format int64 */ actor_id: number; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ integration_id: number | null; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ oauth_application_id: number | null; total_request_count: number; rate_limited_request_count: number; + /** @nullable */ last_rate_limited_timestamp: string | null; last_request_timestamp: string; }[]; @@ -24387,8 +24860,8 @@ export interface components { /** @example repository */ origin: string; /** - * Format: date-time * @example 2018-08-17T04:18:39Z + * @format date-time */ expires_at: string; }; @@ -24412,8 +24885,8 @@ export interface components { */ "org-membership": { /** - * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt + * @format uri */ url: string; /** @@ -24429,8 +24902,8 @@ export interface components { */ role: "admin" | "member" | "billing_manager"; /** - * Format: uri * @example https://api.github.com/orgs/octocat + * @format uri */ organization_url: string; organization: components["schemas"]["organization-simple"]; @@ -24445,8 +24918,8 @@ export interface components { */ migration: { /** - * Format: int64 * @example 79 + * @format int64 */ id: number; owner: components["schemas"]["nullable-simple-user"]; @@ -24465,22 +24938,22 @@ export interface components { /** @description The repositories included in the migration. Only returned for export migrations. */ repositories: components["schemas"]["repository"][]; /** - * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 + * @format uri */ url: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ updated_at: string; node_id: string; - /** Format: uri */ + /** @format uri */ archive_url?: string; /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; @@ -24491,20 +24964,25 @@ export interface components { */ "organization-role": { /** - * Format: int64 * @description The unique identifier of the role. + * @format int64 */ 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. */ + /** + * @nullable + * @description A short description about who this role is for or what permissions it grants. + */ description?: string | null; /** + * @nullable * @description The system role from which this role inherits permissions. * @enum {string|null} */ base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; /** + * @nullable * @description Source answers the question, "where did this role come from?" * @enum {string|null} */ @@ -24513,13 +24991,13 @@ export interface components { permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @description The date and time the role was created. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time the role was last updated. + * @format date-time */ updated_at: string; }; @@ -24538,6 +25016,7 @@ export interface components { node_id: string; name: string; slug: string; + /** @nullable */ description: string | null; privacy?: string; notification_setting?: string; @@ -24549,15 +25028,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; @@ -24574,9 +25053,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -24587,6 +25066,7 @@ export interface components { */ name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -24607,13 +25087,13 @@ export interface components { */ notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; /** @example justice-league */ @@ -24637,7 +25117,9 @@ export interface components { assignment?: "direct" | "indirect" | "mixed"; /** @description Team the user has gotten the role through */ inherited_from?: components["schemas"]["team-simple"][]; + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; @@ -24646,25 +25128,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -24674,25 +25159,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -24728,18 +25213,18 @@ export interface components { license?: string; description?: string; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ deleted_at?: string; /** Package Version Metadata */ @@ -24766,7 +25251,10 @@ export interface components { "organization-programmatic-access-grant-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */ id: number; - /** @description Reason for requesting access. */ + /** + * @nullable + * @description Reason for requesting access. + */ reason: string | null; owner: components["schemas"]["simple-user"]; /** @@ -24796,9 +25284,15 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** @@ -24836,9 +25330,15 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** @@ -24857,6 +25357,7 @@ export interface components { */ registry_type: "maven_repository"; /** + * @nullable * @description The username to use when authenticating with the private registry. * @example monalisa */ @@ -24866,9 +25367,9 @@ export interface components { * @enum {string} */ visibility: "all" | "private" | "selected"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24898,9 +25399,9 @@ export interface components { visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ selected_repository_ids?: number[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24909,23 +25410,23 @@ export interface components { */ project: { /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test + * @format uri */ owner_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604/columns + * @format uri */ columns_url: string; /** @example 1002604 */ @@ -24938,6 +25439,7 @@ export interface components { */ name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -24951,13 +25453,13 @@ export interface components { state: string; creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** @@ -24976,8 +25478,8 @@ export interface components { /** @description The name of the property */ property_name: string; /** - * Format: uri * @description The URL that can be used to fetch, update, or delete info about this property via the API. + * @format uri */ url?: string; /** @@ -24994,16 +25496,24 @@ export interface components { value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ default_value?: (string | string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; /** + * @nullable * @description Who can edit the values of the property * @example org_actors * @enum {string|null} @@ -25023,11 +25533,18 @@ export interface components { value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ default_value?: (string | string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ @@ -25040,7 +25557,10 @@ export interface components { "custom-property-value": { /** @description The name of the property */ property_name: string; - /** @description The value assigned to the property */ + /** + * @nullable + * @description The value assigned to the property + */ value: (string | string[]) | null; }; /** @@ -25059,13 +25579,14 @@ export interface components { }; /** * Repository + * @nullable * @description A repository on GitHub. */ "nullable-repository": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25093,16 +25614,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25124,28 +25648,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25167,13 +25691,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25187,30 +25711,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25218,25 +25742,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -25308,18 +25835,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -25420,8 +25950,8 @@ export interface components { */ "code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ url: string; /** @example citizen_code_of_conduct */ @@ -25429,8 +25959,9 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ html_url: string | null; }; @@ -25440,8 +25971,8 @@ export interface components { */ "full-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25453,16 +25984,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25484,28 +26018,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25527,13 +26061,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25547,30 +26081,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25578,25 +26112,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -25644,18 +26181,18 @@ export interface components { */ visibility?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string; permissions?: { @@ -25668,6 +26205,7 @@ export interface components { /** @example true */ allow_rebase_merge?: boolean; template_repository?: components["schemas"]["nullable-repository"]; + /** @nullable */ temp_clone_token?: string | null; /** @example true */ allow_squash_merge?: boolean; @@ -25757,7 +26295,10 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** + * @nullable + * @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -26238,16 +26779,18 @@ export interface components { /** @description The URL of the ruleset */ href: string; }; + /** @nullable */ html: { /** @description The html URL of the ruleset */ href: string; } | null; }; + /** @nullable */ conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; rules?: components["schemas"]["repository-rule"][]; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }; /** @@ -26272,8 +26815,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string; /** @@ -26294,9 +26837,15 @@ export interface components { "rule-suite": { /** @description The unique identifier of the rule insight. */ id: number; - /** @description The number that identifies the user. */ + /** + * @nullable + * @description The number that identifies the user. + */ actor_id: number | null; - /** @description The handle for the GitHub user account. */ + /** + * @nullable + * @description The handle for the GitHub user account. + */ actor_name: string | null; /** @description The first commit sha before the push evaluation. */ before_sha: string; @@ -26309,8 +26858,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string; /** @@ -26319,6 +26868,7 @@ export interface components { */ result: "pass" | "fail" | "bypass"; /** + * @nullable * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. * @enum {string|null} */ @@ -26328,9 +26878,15 @@ export interface components { rule_source: { /** @description The type of rule source. */ type: string; - /** @description The ID of the rule source. */ + /** + * @nullable + * @description The ID of the rule source. + */ id: number | null; - /** @description The name of the rule source. */ + /** + * @nullable + * @description The name of the rule source. + */ name: string | null; }; /** @@ -26345,23 +26901,41 @@ export interface components { result: "pass" | "fail"; /** @description The type of rule. */ rule_type: string; - /** @description The detailed failure message for the rule. Null if the rule passed. */ + /** + * @nullable + * @description The detailed failure message for the rule. Null if the rule passed. + */ details: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions: string[] | null; }; /** @description A credit given to a user for a repository security advisory. */ @@ -26378,30 +26952,43 @@ export interface components { "repository-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id: string | null; /** - * Format: uri * @description The API URL for the advisory. + * @format uri */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** @description A short summary of the advisory. */ summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ description: string | null; /** + * @nullable * @description The severity of the advisory. * @enum {string|null} */ severity: "critical" | "high" | "medium" | "low" | null; - /** @description The author of the advisory. */ + /** + * @nullable + * @description The author of the advisory. + */ readonly author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ + /** + * @nullable + * @description The publisher of the advisory. + */ readonly publisher: components["schemas"]["simple-user"] | null; readonly identifiers: { /** @@ -26418,61 +27005,90 @@ export interface components { */ state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was created, in ISO 8601 format. + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was closed, in ISO 8601 format. + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; + /** @nullable */ readonly submission: { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; + /** @nullable */ vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + /** @nullable */ cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; + /** @nullable */ readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description A list of only the CWE IDs. */ + /** + * @nullable + * @description A list of only the CWE IDs. + */ cwe_ids: string[] | null; + /** @nullable */ credits: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; }[] | null; + /** @nullable */ readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ + /** + * @nullable + * @description A list of users that collaborate on the advisory. + */ collaborating_users: components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ + /** + * @nullable + * @description A list of teams that collaborate on the advisory. + */ collaborating_teams: components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + /** + * @nullable + * @description A temporary private fork of the advisory's repository for collaborating on a fix. + */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; "actions-billing-usage": { @@ -26557,9 +27173,10 @@ export interface components { */ network_settings_ids?: string[]; /** - * Format: date-time + * @nullable * @description The time at which the network configuration was created, in ISO 8601 format. * @example 2024-04-26T11:31:07Z + * @format date-time */ created_on: string | null; }; @@ -26606,18 +27223,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -26630,25 +27247,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -26665,13 +27288,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** @example Organization */ @@ -26680,15 +27303,25 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; - /** @example 8 */ + /** + * @nullable + * @example 8 + */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -26698,10 +27331,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -26717,13 +27357,19 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ archived_at: string | null; }; /** @@ -26739,14 +27385,14 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** @@ -26756,7 +27402,10 @@ export interface components { name: string; /** @example justice-league */ slug: string; - /** @example A great team. */ + /** + * @nullable + * @example A great team. + */ description: string | null; /** * @description The level of privacy this team should have @@ -26778,8 +27427,8 @@ export interface components { /** @example https://api.github.com/organizations/1/team/1/members{/member} */ members_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; parent?: components["schemas"]["nullable-team-simple"]; @@ -26788,13 +27437,13 @@ export interface components { /** @example 10 */ repos_count: number; /** - * Format: date-time * @example 2017-07-14T16:53:42Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-08-17T12:37:15Z + * @format date-time */ updated_at: string; organization: components["schemas"]["team-organization"]; @@ -26825,20 +27474,23 @@ export interface components { /** @example 0 */ comments_count: number; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments + * @format uri */ comments_url: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ last_edited_at: string | null; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 + * @format uri */ html_url: string; /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ @@ -26859,8 +27511,8 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027 + * @format uri */ team_url: string; /** @@ -26869,13 +27521,13 @@ export interface components { */ title: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 + * @format uri */ url: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -26899,20 +27551,23 @@ export interface components { */ body_version: string; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ last_edited_at: string | null; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @format uri */ discussion_url: string; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @format uri */ html_url: string; /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ @@ -26923,13 +27578,13 @@ export interface components { */ number: number; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + * @format uri */ url: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -26951,8 +27606,8 @@ export interface components { */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** - * Format: date-time * @example 2016-05-20T20:09:31Z + * @format date-time */ created_at: string; }; @@ -26961,7 +27616,7 @@ export interface components { * @description Team Membership */ "team-membership": { - /** Format: uri */ + /** @format uri */ url: string; /** * @description The role of the user in the team. @@ -26988,6 +27643,7 @@ export interface components { id: number; node_id: string; name: string; + /** @nullable */ body: string | null; number: number; state: string; @@ -27041,16 +27697,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -27072,28 +27731,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -27115,13 +27774,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -27135,30 +27794,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -27166,25 +27825,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -27246,18 +27908,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -27315,29 +27980,32 @@ export interface components { */ "project-card": { /** - * Format: uri * @example https://api.github.com/projects/columns/cards/1478 + * @format uri */ url: string; /** - * Format: int64 * @description The project card's ID * @example 42 + * @format int64 */ id: number; /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ node_id: string; - /** @example Add payload for delete Project column */ + /** + * @nullable + * @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 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2016-09-05T14:20:22Z + * @format date-time */ updated_at: string; /** @@ -27348,18 +28016,18 @@ export interface components { column_name?: string; project_id?: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ column_url: string; /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 + * @format uri */ content_url?: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ project_url: string; }; @@ -27369,18 +28037,18 @@ export interface components { */ "project-column": { /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ project_url: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367/cards + * @format uri */ cards_url: string; /** @@ -27396,13 +28064,13 @@ export interface components { */ name: string; /** - * Format: date-time * @example 2016-09-05T14:18:44Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2016-09-05T14:22:28Z + * @format date-time */ updated_at: string; }; @@ -27466,12 +28134,22 @@ export interface components { archive_download_url: string; /** @description Whether or not the artifact has expired. */ expired: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; + /** @nullable */ workflow_run?: { /** @example 10 */ id: number; @@ -27506,13 +28184,13 @@ export interface components { /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ version: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ last_accessed_at: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at: string; /** @example 1024 */ @@ -27550,7 +28228,10 @@ export interface components { head_sha: string; /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ html_url: string | null; /** * @description The phase of the lifecycle that the job is currently in. @@ -27559,27 +28240,29 @@ export interface components { */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @description The outcome of the job. * @example success * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time * @description The time that the job created, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ started_at: string; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ completed_at: string | null; /** @@ -27596,6 +28279,7 @@ export interface components { */ status: "queued" | "in_progress" | "completed"; /** + * @nullable * @description The outcome of the job. * @example success */ @@ -27608,15 +28292,17 @@ export interface components { /** @example 1 */ number: number; /** - * Format: date-time + * @nullable * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ started_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ completed_at?: string | null; }[]; @@ -27632,31 +28318,37 @@ export interface components { */ labels: string[]; /** + * @nullable * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ runner_id: number | null; /** + * @nullable * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ runner_name: string | null; /** + * @nullable * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ runner_group_id: number | null; /** + * @nullable * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ runner_group_name: string | null; /** + * @nullable * @description The name of the workflow. * @example Build */ workflow_name: string | null; /** + * @nullable * @description The name of the current branch. * @example main */ @@ -27682,9 +28374,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** Actions Variable */ @@ -27700,15 +28392,15 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ updated_at: string; }; @@ -27740,7 +28432,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { - /** Format: int64 */ + /** @format int64 */ id: number; number: number; url: string; @@ -27748,7 +28440,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -27758,7 +28450,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -27767,6 +28459,7 @@ export interface components { }; /** * Simple Commit + * @nullable * @description A commit. */ "nullable-simple-commit": { @@ -27783,12 +28476,15 @@ export interface components { */ message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ author: { /** * @description Name of the commit's author @@ -27796,13 +28492,16 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ committer: { /** * @description Name of the commit's committer @@ -27810,9 +28509,9 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; @@ -27828,6 +28527,7 @@ export interface components { */ id: number; /** + * @nullable * @description The name of the workflow run. * @example Build */ @@ -27844,7 +28544,10 @@ export interface components { * @example MDEwOkNoZWNrU3VpdGU0Mg== */ check_suite_node_id?: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that points to the version of the workflow being run. @@ -27866,12 +28569,19 @@ export interface components { * @example 1 */ run_attempt?: number; + /** @nullable */ referenced_workflows?: components["schemas"]["referenced-workflow"][] | null; /** @example push */ event: string; - /** @example completed */ + /** + * @nullable + * @example completed + */ status: string | null; - /** @example neutral */ + /** + * @nullable + * @example neutral + */ conclusion: string | null; /** * @description The ID of the parent workflow. @@ -27885,17 +28595,20 @@ export interface components { url: string; /** @example https://github.com/github/hello-world/suites/4 */ html_url: string; - /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */ + /** + * @nullable + * @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. + */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; actor?: components["schemas"]["simple-user"]; triggering_actor?: components["schemas"]["simple-user"]; /** - * Format: date-time * @description The start time of the latest run. Resets on re-run. + * @format date-time */ run_started_at?: string; /** @@ -27929,6 +28642,7 @@ export interface components { */ rerun_url: string; /** + * @nullable * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ @@ -27973,15 +28687,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ updated_at: string; }[]; @@ -28028,9 +28742,9 @@ export interface components { "pending-deployment": { environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ id: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -28051,9 +28765,10 @@ export interface components { */ wait_timer: number; /** - * Format: date-time + * @nullable * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z + * @format date-time */ wait_timer_started_at: string | null; /** @@ -28073,14 +28788,14 @@ export interface components { */ deployment: { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ url: string; /** - * Format: int64 * @description Unique identifier of the deployment * @example 42 + * @format int64 */ id: number; /** @example MDEwOkRlcGxveW1lbnQx */ @@ -28107,27 +28822,30 @@ export interface components { * @example production */ environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** @@ -28194,13 +28912,13 @@ export interface components { */ state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ updated_at: string; /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ @@ -28210,8 +28928,8 @@ export interface components { /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ badge_url: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ deleted_at?: string; }; @@ -28257,9 +28975,9 @@ export interface components { */ ref: string; /** - * Format: date-time * @description The time when the activity occurred. * @example 2011-01-26T19:06:43Z + * @format date-time */ timestamp: string; /** @@ -28319,6 +29037,7 @@ export interface components { contexts: string[]; checks: { context: string; + /** @nullable */ app_id: number | null; }[]; contexts_url?: string; @@ -28330,8 +29049,8 @@ export interface components { */ "protected-branch-admin-enforced": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + * @format uri */ url: string; /** @example true */ @@ -28343,8 +29062,8 @@ export interface components { */ "protected-branch-pull-request-review": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + * @format uri */ url?: string; dismissal_restrictions?: { @@ -28388,17 +29107,17 @@ export interface components { * @description Branch Restriction Policy */ "branch-restriction-policy": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ apps_url: string; users: { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; avatar_url: string; @@ -28425,12 +29144,14 @@ export interface components { html_url: string; name: string; slug: string; + /** @nullable */ description: string | null; privacy: string; notification_setting: string; permission: string; members_url: string; repositories_url: string; + /** @nullable */ parent: string | null; }[]; apps: { @@ -28523,8 +29244,8 @@ export interface components { protection_url: string; required_signatures: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ url: string; /** @example true */ @@ -28549,16 +29270,17 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; protected: boolean; protection?: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url?: string; }; /** * Git User + * @nullable * @description Metaproperties for Git author/committer information. */ "nullable-git-user": { @@ -28573,8 +29295,11 @@ export interface components { verification: { verified: boolean; reason: string; + /** @nullable */ payload: string | null; + /** @nullable */ signature: string | null; + /** @nullable */ verified_at?: string | null; }; /** @@ -28598,18 +29323,18 @@ export interface components { /** @example 124 */ changes: number; /** - * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ blob_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ raw_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ contents_url: string; /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ @@ -28623,8 +29348,8 @@ export interface components { */ commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ url: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ @@ -28632,19 +29357,19 @@ export interface components { /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + * @format uri */ comments_url: string; commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ url: string; author: components["schemas"]["nullable-git-user"]; @@ -28657,26 +29382,28 @@ export interface components { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + * @format uri */ url: string; }; verification?: components["schemas"]["verification"]; }; + /** @nullable */ author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + /** @nullable */ committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ html_url?: string; }[]; @@ -28696,12 +29423,12 @@ export interface components { commit: components["schemas"]["commit"]; _links: { html: string; - /** Format: uri */ + /** @format uri */ self: string; }; protected: boolean; protection: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url: string; /** @example "mas*" */ pattern?: string; @@ -28714,8 +29441,8 @@ export interface components { */ "status-check-policy": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + * @format uri */ url: string; /** @example true */ @@ -28729,11 +29456,12 @@ export interface components { checks: { /** @example continuous-integration/travis-ci */ context: string; + /** @nullable */ app_id: number | null; }[]; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + * @format uri */ contexts_url: string; }; @@ -28742,11 +29470,11 @@ export interface components { * @description Branch protections protect branches */ "protected-branch": { - /** Format: uri */ + /** @format uri */ url: string; required_status_checks?: components["schemas"]["status-check-policy"]; required_pull_request_reviews?: { - /** Format: uri */ + /** @format uri */ url: string; dismiss_stale_reviews?: boolean; require_code_owner_reviews?: boolean; @@ -28757,11 +29485,11 @@ export interface components { */ require_last_push_approval: boolean; dismissal_restrictions?: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; users: components["schemas"]["simple-user"][]; teams: components["schemas"]["team"][]; @@ -28775,15 +29503,15 @@ export interface components { }; required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ url: string; /** @example true */ enabled: boolean; }; enforce_admins?: { - /** Format: uri */ + /** @format uri */ url: string; enabled: boolean; }; @@ -28820,8 +29548,8 @@ export interface components { */ "deployment-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ url: string; /** @@ -28843,26 +29571,29 @@ export interface components { * @example production */ environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ description: string | null; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** @@ -28883,9 +29614,9 @@ export interface components { */ "check-run": { /** - * Format: int64 * @description The id of the check. * @example 21 + * @format int64 */ id: number; /** @@ -28895,13 +29626,22 @@ export interface components { head_sha: string; /** @example MDg6Q2hlY2tSdW40 */ node_id: string; - /** @example 42 */ + /** + * @nullable + * @example 42 + */ external_id: string | null; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ html_url: string | null; - /** @example https://example.com */ + /** + * @nullable + * @example https://example.com + */ details_url: string | null; /** * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. @@ -28910,26 +29650,32 @@ export interface components { */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ started_at: string | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ completed_at: string | null; output: { + /** @nullable */ title: string | null; + /** @nullable */ summary: string | null; + /** @nullable */ text: string | null; annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; }; /** @@ -28937,6 +29683,7 @@ export interface components { * @example test-coverage */ name: string; + /** @nullable */ check_suite: { id: number; } | null; @@ -28956,17 +29703,35 @@ export interface components { start_line: number; /** @example 2 */ end_line: number; - /** @example 5 */ + /** + * @nullable + * @example 5 + */ start_column: number | null; - /** @example 10 */ + /** + * @nullable + * @example 10 + */ end_column: number | null; - /** @example warning */ + /** + * @nullable + * @example warning + */ annotation_level: string | null; - /** @example Spell Checker */ + /** + * @nullable + * @example Spell Checker + */ title: string | null; - /** @example Check your spelling for 'banaas'. */ + /** + * @nullable + * @example Check your spelling for 'banaas'. + */ message: string | null; - /** @example Do you mean 'bananas' or 'banana'? */ + /** + * @nullable + * @example Do you mean 'bananas' or 'banana'? + */ raw_details: string | null; blob_href: string; }; @@ -28988,12 +29753,15 @@ export interface components { */ message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ author: { /** * @description Name of the commit's author @@ -29001,13 +29769,16 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ committer: { /** * @description Name of the commit's committer @@ -29015,9 +29786,9 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; @@ -29028,13 +29799,16 @@ export interface components { */ "check-suite": { /** - * Format: int64 * @example 5 + * @format int64 */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that is being checked. @@ -29042,28 +29816,46 @@ export interface components { */ head_sha: string; /** + * @nullable * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; - /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ + /** + * @nullable + * @example https://api.github.com/repos/github/hello-world/check-suites/5 + */ url: string | null; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ before: string | null; - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ after: string | null; + /** @nullable */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; app: components["schemas"]["nullable-integration"]; repository: components["schemas"]["minimal-repository"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; head_commit: components["schemas"]["simple-commit"]; latest_check_runs_count: number; @@ -29102,16 +29894,21 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; "code-scanning-alert-rule": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ id: string | null; /** @description The name of the rule used to detect the alert. */ name: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -29120,11 +29917,20 @@ export interface components { description: string; /** @description A description of the rule used to detect the alert. */ full_description: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ tags: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ help: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri: string | null; }; "code-scanning-alert": { @@ -29154,11 +29960,14 @@ export interface components { * @enum {string} */ "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; - /** @description The description of an autofix. */ + /** + * @nullable + * @description The description of an autofix. + */ "code-scanning-autofix-description": string | null; /** - * Format: date-time * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-autofix-started-at": string; "code-scanning-autofix": { @@ -29166,7 +29975,10 @@ export interface components { description: components["schemas"]["code-scanning-autofix-description"]; started_at: components["schemas"]["code-scanning-autofix-started-at"]; }; - /** @description Commit an autofix for a code scanning alert */ + /** + * @nullable + * @description Commit an autofix for a code scanning alert + */ "code-scanning-autofix-commits": { /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ target_ref: string; @@ -29184,18 +29996,21 @@ export interface components { * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ "code-scanning-analysis-sarif-id": string; - /** @description The SHA of the commit to which the analysis you are uploading relates. */ + /** + * @description The SHA of the commit to which the analysis you are uploading relates. + * @pattern ^[0-9a-fA-F]+$ + */ "code-scanning-analysis-commit-sha": string; /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ "code-scanning-analysis-environment": string; /** - * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-analysis-created-at": string; /** - * Format: uri * @description The REST API URL of the analysis resource. + * @format uri */ "code-scanning-analysis-url": string; "code-scanning-analysis": { @@ -29229,13 +30044,15 @@ export interface components { */ "code-scanning-analysis-deletion": { /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, without last analysis deletion confirmation + * @format uri */ readonly next_analysis_url: string | null; /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, with last analysis deletion confirmation + * @format uri */ readonly confirm_delete_url: string | null; }; @@ -29256,21 +30073,24 @@ export interface components { /** @description The size of the CodeQL database file in bytes. */ size: number; /** - * Format: date-time * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** - * Format: uri * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. + * @format uri */ url: string; - /** @description The commit SHA of the repository at the time the CodeQL database was created. */ + /** + * @nullable + * @description The commit SHA of the repository at the time the CodeQL database was created. + */ commit_oid?: string | null; }; /** @@ -29303,8 +30123,9 @@ export interface components { /** @example 80 */ stargazers_count: number; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; }; @@ -29335,18 +30156,19 @@ export interface components { /** @description The download url for the query pack. */ query_pack_url: string; /** - * Format: date-time * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at?: string; /** - * Format: date-time * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at?: string; /** - * Format: date-time + * @nullable * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + * @format date-time */ completed_at?: string | null; /** @enum {string} */ @@ -29410,11 +30232,13 @@ export interface components { /** @description Languages to be analyzed. */ languages: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** + * @nullable * @description Runner type to be used. * @enum {string|null} */ runner_type: "standard" | "labeled" | null; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29425,12 +30249,14 @@ export interface components { */ query_suite: "default" | "extended"; /** - * Format: date-time + * @nullable * @description Timestamp of latest configuration update. * @example 2023-12-06T14:20:20.000Z + * @format date-time */ updated_at: string | null; /** + * @nullable * @description The frequency of the periodic analysis. * @enum {string|null} */ @@ -29449,6 +30275,7 @@ export interface components { */ runner_type: "standard" | "labeled"; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29475,6 +30302,7 @@ export interface components { * @description The full Git reference, formatted as `refs/heads/`, * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main + * @pattern ^refs/(heads|tags|pull)/.*$ */ "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)." */ @@ -29482,8 +30310,8 @@ export interface components { "code-scanning-sarifs-receipt": { id: components["schemas"]["code-scanning-analysis-sarif-id"]; /** - * Format: uri * @description The REST API URL for checking the status of the upload. + * @format uri */ readonly url: string; }; @@ -29494,11 +30322,15 @@ export interface components { */ processing_status: "pending" | "complete" | "failed"; /** - * Format: uri + * @nullable * @description The REST API URL for getting the analyses associated with the upload. + * @format uri */ readonly analyses_url: string | null; - /** @description Any errors that ocurred during processing of the delivery. */ + /** + * @nullable + * @description Any errors that ocurred during processing of the delivery. + */ readonly errors: string[] | null; }; /** @description Code security configuration associated with a repository and attachment status */ @@ -29537,6 +30369,7 @@ export interface components { */ kind: string; /** + * @nullable * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. * @example The pattern `/` will never match anything, did you mean `*` instead? */ @@ -29592,6 +30425,7 @@ export interface components { */ cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -29619,9 +30453,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -29632,34 +30466,39 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29669,25 +30508,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -29711,9 +30550,9 @@ export interface components { */ "repository-invitation": { /** - * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 + * @format int64 */ id: number; repository: components["schemas"]["minimal-repository"]; @@ -29726,8 +30565,8 @@ export interface components { */ permissions: "read" | "write" | "admin" | "triage" | "maintain"; /** - * Format: date-time * @example 2016-06-13T14:52:50-05:00 + * @format date-time */ created_at: string; /** @description Whether or not the invitation has expired */ @@ -29743,40 +30582,46 @@ export interface components { }; /** * Collaborator + * @nullable * @description Collaborator */ "nullable-collaborator": { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29786,25 +30631,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -29837,21 +30682,24 @@ export interface components { * @description Commit Comment */ "commit-comment": { - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ url: string; id: number; node_id: string; body: string; + /** @nullable */ path: string | null; + /** @nullable */ position: number | null; + /** @nullable */ line: number | null; commit_id: string; user: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -29877,6 +30725,7 @@ export interface components { }; /** * Auto merge + * @nullable * @description The status of auto merging a pull request. */ "auto-merge": { @@ -29897,57 +30746,57 @@ export interface components { */ "pull-request-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ statuses_url: string; /** @example 1347 */ @@ -29959,10 +30808,13 @@ export interface components { /** @example new-feature */ title: string; user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; @@ -29972,33 +30824,44 @@ export interface components { default: boolean; }[]; milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ merge_commit_sha: string | null; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_reviewers?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_teams?: components["schemas"]["team"][] | null; head: { label: string; @@ -30034,21 +30897,29 @@ export interface components { }; /** Simple Commit Status */ "simple-commit-status": { + /** @nullable */ description: string | null; id: number; node_id: string; state: string; context: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ target_url: string | null; + /** @nullable */ required?: boolean | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ avatar_url: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30061,9 +30932,9 @@ export interface components { sha: string; total_count: number; repository: components["schemas"]["minimal-repository"]; - /** Format: uri */ + /** @format uri */ commit_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -30072,11 +30943,14 @@ export interface components { */ status: { url: string; + /** @nullable */ avatar_url: string | null; id: number; node_id: string; state: string; + /** @nullable */ description: string | null; + /** @nullable */ target_url: string | null; context: string; created_at: string; @@ -30085,12 +30959,13 @@ export interface components { }; /** * Code Of Conduct Simple + * @nullable * @description Code of Conduct Simple */ "nullable-code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ url: string; /** @example citizen_code_of_conduct */ @@ -30098,16 +30973,20 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ html_url: string | null; } | null; - /** Community Health File */ + /** + * Community Health File + * @nullable + */ "nullable-community-health-file": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; } | null; /** @@ -30117,9 +30996,15 @@ export interface components { "community-profile": { /** @example 100 */ health_percentage: number; - /** @example My first repository on GitHub! */ + /** + * @nullable + * @example My first repository on GitHub! + */ description: string | null; - /** @example example.com */ + /** + * @nullable + * @example example.com + */ documentation: string | null; files: { code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; @@ -30131,8 +31016,9 @@ export interface components { pull_request_template: components["schemas"]["nullable-community-health-file"]; }; /** - * Format: date-time + * @nullable * @example 2017-02-28T19:09:29Z + * @format date-time */ updated_at: string | null; /** @example true */ @@ -30144,28 +31030,28 @@ export interface components { */ "commit-comparison": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + * @format uri */ permalink_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch + * @format uri */ patch_url: string; base_commit: components["schemas"]["commit"]; @@ -30195,13 +31081,22 @@ export interface components { path: string; sha: string; content?: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; entries?: { type: string; @@ -30209,29 +31104,50 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30247,20 +31163,35 @@ export interface components { path: string; content?: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; @@ -30280,20 +31211,35 @@ export interface components { path: string; content: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; /** @example "actual/actual.md" */ @@ -30316,20 +31262,35 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30343,26 +31304,41 @@ export interface components { * @enum {string} */ type: "submodule"; - /** Format: uri */ + /** @format uri */ submodule_git_url: string; size: number; name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30371,6 +31347,7 @@ export interface components { * @description File Commit */ "file-commit": { + /** @nullable */ content: { name: string; path: string; @@ -30415,8 +31392,11 @@ export interface components { verification: { verified: boolean; reason: string; + /** @nullable */ signature: string | null; + /** @nullable */ payload: string | null; + /** @nullable */ verified_at: string | null; }; }; @@ -30445,26 +31425,27 @@ export interface components { login?: string; id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ avatar_url?: string; + /** @nullable */ gravatar_id?: string | null; - /** Format: uri */ + /** @format uri */ url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; following_url?: string; gists_url?: string; starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; events_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; type: string; site_admin?: boolean; @@ -30487,6 +31468,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -30501,11 +31483,15 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; @@ -30520,9 +31506,9 @@ export interface components { * @example MY_ARTIFACTORY_PASSWORD */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30540,11 +31526,20 @@ export interface components { name: string; /** @example 1.0.0 */ version: string; - /** @example pkg:/npm/%40actions/core@1.1.0 */ + /** + * @nullable + * @example pkg:/npm/%40actions/core@1.1.0 + */ package_url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ license: string | null; - /** @example https://github.com/github/actions */ + /** + * @nullable + * @example https://github.com/github/actions + */ source_repository_url: string | null; vulnerabilities: { /** @example critical */ @@ -30699,6 +31694,7 @@ export interface components { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. * @example pkg:/npm/%40actions/http-client@1.0.11 + * @pattern ^pkg */ package_url: string; metadata: components["schemas"]["metadata"]; @@ -30771,6 +31767,7 @@ export interface components { /** * @description The repository branch that triggered this snapshot. * @example refs/heads/main + * @pattern ^refs/ */ ref: string; /** @description A description of the detector used. */ @@ -30797,9 +31794,9 @@ export interface components { [key: string]: components["schemas"]["manifest"]; }; /** - * Format: date-time * @description The time at which the snapshot was scanned. * @example 2020-06-13T14:52:50-05:00 + * @format date-time */ scanned: string; }; @@ -30809,13 +31806,13 @@ export interface components { */ "deployment-status": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ @@ -30840,44 +31837,44 @@ export interface components { */ environment: string; /** - * Format: uri * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ target_url: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 + * @format uri */ deployment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** - * Format: uri * @description The URL for accessing your environment. * @default * @example https://staging.example.com/ + * @format uri */ environment_url: string; /** - * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -30887,7 +31884,10 @@ export interface components { * @example 30 */ "wait-timer": number; - /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ + /** + * @nullable + * @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. + */ "deployment-branch-policy-settings": { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ protected_branches: boolean; @@ -30900,9 +31900,9 @@ export interface components { */ environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ id: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -30917,15 +31917,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ updated_at: string; /** @description Built-in deployment protection rules for the environment. */ @@ -31084,9 +32084,10 @@ export interface components { blob: { content: string; encoding: string; - /** Format: uri */ + /** @format uri */ url: string; sha: string; + /** @nullable */ size: number | null; node_id: string; highlighted_content?: string; @@ -31102,14 +32103,14 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -31126,9 +32127,9 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -31153,7 +32154,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -31162,19 +32163,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { verified: boolean; reason: string; + /** @nullable */ signature: string | null; + /** @nullable */ payload: string | null; + /** @nullable */ verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -31184,7 +32188,7 @@ export interface components { "git-ref": { ref: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; object: { type: string; @@ -31193,7 +32197,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; }; @@ -31212,9 +32216,9 @@ export interface components { /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ sha: string; /** - * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + * @format uri */ url: string; /** @@ -31230,7 +32234,7 @@ export interface components { object: { sha: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; }; verification?: components["schemas"]["verification"]; @@ -31241,7 +32245,7 @@ export interface components { */ "git-tree": { sha: string; - /** Format: uri */ + /** @format uri */ url: string; truncated: boolean; /** @@ -31302,8 +32306,11 @@ export interface components { }; /** Hook Response */ "hook-response": { + /** @nullable */ code: number | null; + /** @nullable */ status: string | null; + /** @nullable */ message: string | null; }; /** @@ -31337,33 +32344,33 @@ export interface components { events: string[]; config: components["schemas"]["webhook-config"]; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test + * @format uri */ test_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + * @format uri */ ping_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries + * @format uri */ deliveries_url?: string; last_response: components["schemas"]["hook-response"]; @@ -31373,6 +32380,7 @@ export interface components { * @description A repository import from an external source. */ import: { + /** @nullable */ vcs: string | null; use_lfs?: boolean; /** @description The URL of the originating repository. */ @@ -31381,11 +32389,17 @@ export interface components { tfvc_project?: string; /** @enum {string} */ status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; + /** @nullable */ status_text?: string | null; + /** @nullable */ failed_step?: string | null; + /** @nullable */ error_message?: string | null; + /** @nullable */ import_percent?: number | null; + /** @nullable */ commit_count?: number | null; + /** @nullable */ push_percent?: number | null; has_large_files?: boolean; large_files_size?: number; @@ -31396,14 +32410,15 @@ export interface components { human_name: string; }[]; message?: string; + /** @nullable */ authors_count?: number | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ authors_url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; svn_root?: string; }; @@ -31417,9 +32432,9 @@ export interface components { remote_name: string; email: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ import_url: string; }; /** @@ -31434,26 +32449,27 @@ export interface components { }; /** * Issue + * @nullable * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ "nullable-issue": { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -31466,6 +32482,7 @@ export interface components { */ state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -31477,6 +32494,7 @@ export interface components { */ title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -31490,45 +32508,67 @@ export interface components { * ] */ labels: (string | { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; name: string; + /** @nullable */ description: string | null; + /** @nullable */ color: string | null; default: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; comments: number; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; draft?: boolean; closed_by?: components["schemas"]["nullable-simple-user"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -31541,14 +32581,18 @@ export interface components { * @description Issue Event Label */ "issue-event-label": { + /** @nullable */ name: string | null; + /** @nullable */ color: string | null; }; /** Issue Event Dismissed Review */ "issue-event-dismissed-review": { state: string; review_id: number; + /** @nullable */ dismissal_message: string | null; + /** @nullable */ dismissal_commit_id?: string | null; }; /** @@ -31563,10 +32607,10 @@ export interface components { * @description Issue Event Project Card */ "issue-event-project-card": { - /** Format: uri */ + /** @format uri */ url: string; id: number; - /** Format: uri */ + /** @format uri */ project_url: string; project_id: number; column_name: string; @@ -31586,27 +32630,33 @@ export interface components { */ "issue-event": { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDEwOklzc3VlRXZlbnQx */ node_id: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 + * @format uri */ url: string; actor: components["schemas"]["nullable-simple-user"]; /** @example closed */ event: string; - /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e + */ commit_id: string | null; - /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ commit_url: string | null; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; issue?: components["schemas"]["nullable-issue"]; @@ -31621,6 +32671,7 @@ export interface components { project_card?: components["schemas"]["issue-event-project-card"]; rename?: components["schemas"]["issue-event-rename"]; author_association?: components["schemas"]["author-association"]; + /** @nullable */ lock_reason?: string | null; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; @@ -31634,7 +32685,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31653,7 +32706,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31672,7 +32727,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["integration"]; @@ -31689,7 +32746,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31706,7 +32765,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31724,7 +32785,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31742,7 +32805,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31761,7 +32826,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31779,7 +32846,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31797,13 +32866,16 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; dismissed_review: { state: string; review_id: number; + /** @nullable */ dismissal_message: string | null; dismissal_commit_id?: string; }; @@ -31818,11 +32890,16 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; - /** @example "off-topic" */ + /** + * @nullable + * @example "off-topic" + */ lock_reason: string | null; }; /** @@ -31835,16 +32912,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31860,16 +32939,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31885,16 +32966,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31910,16 +32993,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31936,17 +33021,17 @@ export interface components { */ label: { /** - * Format: int64 * @description Unique identifier for the label. * @example 208045946 + * @format int64 */ id: number; /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ node_id: string; /** - * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug + * @format uri */ url: string; /** @@ -31955,6 +33040,7 @@ export interface components { */ name: string; /** + * @nullable * @description Optional description of the label, such as its purpose. * @example Something isn't working */ @@ -31984,9 +33070,9 @@ export interface components { id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ url: string; /** @@ -31996,20 +33082,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -32022,9 +33108,9 @@ export interface components { "timeline-cross-referenced-event": { event: string; actor?: components["schemas"]["simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; source: { type: string; @@ -32043,14 +33129,14 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -32067,9 +33153,9 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -32094,7 +33180,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -32103,19 +33189,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { verified: boolean; reason: string; + /** @nullable */ signature: string | null; + /** @nullable */ payload: string | null; + /** @nullable */ verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -32133,6 +33222,7 @@ export interface components { node_id: string; user: components["schemas"]["simple-user"]; /** + * @nullable * @description The text of the review. * @example This looks great. */ @@ -32140,13 +33230,13 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ pull_request_url: string; _links: { @@ -32157,7 +33247,7 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** * @description A commit SHA for the review. @@ -32179,15 +33269,16 @@ export interface components { */ url: string; /** - * Format: int64 + * @nullable * @description The ID of the pull request review to which the comment belongs. * @example 42 + * @format int64 */ pull_request_review_id: number | null; /** - * Format: int64 * @description The ID of the pull request review comment. * @example 1 + * @format int64 */ id: number; /** @@ -32237,62 +33328,65 @@ export interface components { */ body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; /** - * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ html_url: string; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ pull_request_url: string; author_association: components["schemas"]["author-association"]; _links: { self: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ href: string; }; html: { /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ href: string; }; pull_request: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ href: string; }; }; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ start_line?: number | null; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ original_start_line?: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -32354,7 +33448,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32370,7 +33466,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32386,10 +33484,13 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; + /** @nullable */ state_reason?: string | null; }; /** @@ -32409,7 +33510,9 @@ export interface components { verified: boolean; created_at: string; read_only: boolean; + /** @nullable */ added_by?: string | null; + /** @nullable */ last_used?: string | null; enabled?: boolean; }; @@ -32429,23 +33532,38 @@ export interface components { path: string; sha: string; size: number; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; type: string; content: string; encoding: string; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; license: components["schemas"]["nullable-license-simple"]; @@ -32466,18 +33584,18 @@ export interface components { */ milestone: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ labels_url: string; /** @example 1002604 */ @@ -32501,7 +33619,10 @@ export interface components { * @example v1.0 */ title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -32509,23 +33630,25 @@ export interface components { /** @example 8 */ closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ due_on: string | null; }; @@ -32551,7 +33674,7 @@ export interface components { * ] */ domains: string[]; - /** Format: date */ + /** @format date */ expires_at?: string; }; /** @@ -32560,31 +33683,35 @@ export interface components { */ page: { /** - * Format: uri * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages + * @format uri */ url: string; /** + * @nullable * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ status: "built" | "building" | "errored" | null; /** + * @nullable * @description The Pages site's custom domain * @example example.com */ cname: string | null; /** + * @nullable * @description The state if the domain is verified * @example pending * @enum {string|null} */ protected_domain_state?: "pending" | "verified" | "unverified" | null; /** - * Format: date-time + * @nullable * @description The timestamp when a pending domain becomes unverified. + * @format date-time */ pending_domain_unverified_at?: string | null; /** @@ -32594,12 +33721,13 @@ export interface components { */ custom_404: boolean; /** - * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com + * @format uri */ html_url?: string; /** + * @nullable * @description The process in which the Page will be built. * @example legacy * @enum {string|null} @@ -32623,18 +33751,19 @@ export interface components { * @description Page Build */ "page-build": { - /** Format: uri */ + /** @format uri */ url: string; status: string; error: { + /** @nullable */ message: string | null; }; pusher: components["schemas"]["nullable-simple-user"]; commit: string; duration: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -32643,8 +33772,8 @@ export interface components { */ "page-build-status": { /** - * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest + * @format uri */ url: string; /** @example queued */ @@ -32658,21 +33787,21 @@ export interface components { /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ id: number | string; /** - * Format: uri * @description The URI to monitor GitHub Pages deployment status. * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 + * @format uri */ status_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages. * @example hello-world.github.io + * @format uri */ page_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages preview. * @example monalisa-1231a2312sa32-23sda74.drafts.github.io + * @format uri */ preview_url?: string; }; @@ -32694,59 +33823,96 @@ export interface components { uri: string; nameservers: string; dns_resolves: boolean; + /** @nullable */ is_proxied: boolean | null; + /** @nullable */ is_cloudflare_ip: boolean | null; + /** @nullable */ is_fastly_ip: boolean | null; + /** @nullable */ is_old_ip_address: boolean | null; + /** @nullable */ is_a_record: boolean | null; + /** @nullable */ has_cname_record: boolean | null; + /** @nullable */ has_mx_records_present: boolean | null; is_valid_domain: boolean; is_apex_domain: boolean; + /** @nullable */ should_be_a_record: boolean | null; + /** @nullable */ is_cname_to_github_user_domain: boolean | null; + /** @nullable */ is_cname_to_pages_dot_github_dot_com: boolean | null; + /** @nullable */ is_cname_to_fastly: boolean | null; + /** @nullable */ is_pointed_to_github_pages_ip: boolean | null; + /** @nullable */ is_non_github_pages_ip_present: boolean | null; is_pages_domain: boolean; + /** @nullable */ is_served_by_pages: boolean | null; is_valid: boolean; + /** @nullable */ reason: string | null; responds_to_https: boolean; enforces_https: boolean; + /** @nullable */ https_error: string | null; + /** @nullable */ is_https_eligible: boolean | null; + /** @nullable */ caa_error: string | null; }; + /** @nullable */ alt_domain: { host: string; uri: string; nameservers: string; dns_resolves: boolean; + /** @nullable */ is_proxied: boolean | null; + /** @nullable */ is_cloudflare_ip: boolean | null; + /** @nullable */ is_fastly_ip: boolean | null; + /** @nullable */ is_old_ip_address: boolean | null; + /** @nullable */ is_a_record: boolean | null; + /** @nullable */ has_cname_record: boolean | null; + /** @nullable */ has_mx_records_present: boolean | null; is_valid_domain: boolean; is_apex_domain: boolean; + /** @nullable */ should_be_a_record: boolean | null; + /** @nullable */ is_cname_to_github_user_domain: boolean | null; + /** @nullable */ is_cname_to_pages_dot_github_dot_com: boolean | null; + /** @nullable */ is_cname_to_fastly: boolean | null; + /** @nullable */ is_pointed_to_github_pages_ip: boolean | null; + /** @nullable */ is_non_github_pages_ip_present: boolean | null; is_pages_domain: boolean; + /** @nullable */ is_served_by_pages: boolean | null; is_valid: boolean; + /** @nullable */ reason: string | null; responds_to_https: boolean; enforces_https: boolean; + /** @nullable */ https_error: string | null; + /** @nullable */ is_https_eligible: boolean | null; + /** @nullable */ caa_error: string | null; } | null; }; @@ -32756,57 +33922,57 @@ export interface components { */ "pull-request": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ statuses_url: string; /** @@ -32828,46 +33994,61 @@ export interface components { */ title: string; user: components["schemas"]["simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; name: string; + /** @nullable */ description: string | null; color: string; default: boolean; }[]; milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ merge_commit_sha: string | null; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_reviewers?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_teams?: components["schemas"]["team-simple"][] | null; head: { label: string; @@ -32901,9 +34082,15 @@ export interface components { */ draft?: boolean; merged: boolean; - /** @example true */ + /** + * @nullable + * @example true + */ mergeable: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ rebaseable?: boolean | null; /** @example clean */ mergeable_state: string; @@ -32949,9 +34136,9 @@ export interface components { */ "pull-request-review": { /** - * Format: int64 * @description Unique identifier of the review * @example 42 + * @format int64 */ id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ @@ -32965,13 +34152,13 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ pull_request_url: string; _links: { @@ -32982,9 +34169,10 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** + * @nullable * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ @@ -32999,18 +34187,19 @@ export interface components { */ "review-comment": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ url: string; /** - * Format: int64 + * @nullable * @example 42 + * @format int64 */ pull_request_review_id: number | null; /** - * Format: int64 * @example 10 + * @format int64 */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ @@ -33019,7 +34208,10 @@ export interface components { diff_hunk: string; /** @example file1.txt */ path: string; - /** @example 1 */ + /** + * @nullable + * @example 1 + */ position: number | null; /** @example 4 */ original_position: number; @@ -33033,23 +34225,23 @@ export interface components { /** @example Great stuff */ body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ pull_request_url: string; author_association: components["schemas"]["author-association"]; @@ -33068,6 +34260,7 @@ export interface components { */ side: "LEFT" | "RIGHT"; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -33084,11 +34277,13 @@ export interface components { */ original_line?: number; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ start_line?: number | null; /** + * @nullable * @description The original first line of the range for a multi-line comment. * @example 2 */ @@ -33099,9 +34294,9 @@ export interface components { * @description Data related to a release. */ "release-asset": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ browser_download_url: string; id: number; node_id: string; @@ -33110,6 +34305,7 @@ export interface components { * @example Team Environment */ name: string; + /** @nullable */ label: string | null; /** * @description State of the release asset. @@ -33119,9 +34315,9 @@ export interface components { content_type: string; size: number; download_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; uploader: components["schemas"]["nullable-simple-user"]; }; @@ -33130,16 +34326,22 @@ export interface components { * @description A release. */ release: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ assets_url: string; upload_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; id: number; node_id: string; @@ -33153,7 +34355,9 @@ export interface components { * @example master */ target_commitish: string; + /** @nullable */ name: string | null; + /** @nullable */ body?: string | null; /** * @description true to create a draft (unpublished) release, false to create a published one. @@ -33165,9 +34369,12 @@ export interface components { * @example false */ prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; author: components["schemas"]["simple-user"]; assets: components["schemas"]["release-asset"][]; @@ -33175,8 +34382,8 @@ export interface components { body_text?: string; mentions_count?: number; /** - * Format: uri * @description The URL of the release discussion. + * @format uri */ discussion_url?: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -33221,19 +34428,23 @@ export interface components { url: components["schemas"]["alert-url"]; html_url: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url: string; state: components["schemas"]["secret-scanning-alert-state"]; resolution: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at: string | null; resolved_by: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ resolution_comment: string | null; /** @description The type of secret that secret scanning detected. */ secret_type: string; @@ -33244,22 +34455,33 @@ export interface components { secret_type_display_name: string; /** @description The secret that was detected. */ secret: string; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed: boolean | null; push_protection_bypassed_by: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at: string | null; push_protection_bypass_request_reviewer: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url: string | null; /** @@ -33267,12 +34489,21 @@ export interface components { * @enum {string} */ validity: "active" | "inactive" | "unknown"; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ publicly_leaked: boolean | null; - /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. + */ multi_repo: boolean | null; }; - /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ + /** + * @nullable + * @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; /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ "secret-scanning-location-commit": { @@ -33343,99 +34574,99 @@ export interface components { /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_title_url: string; }; /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ "secret-scanning-location-issue-body": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_body_url: string; }; /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ "secret-scanning-location-issue-comment": { /** - * Format: uri * @description The API URL to get the issue comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ issue_comment_url: string; }; /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ "secret-scanning-location-discussion-title": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082 + * @format uri */ discussion_title_url: string; }; /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ "secret-scanning-location-discussion-body": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussion-4566270 + * @format uri */ discussion_body_url: string; }; /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ "secret-scanning-location-discussion-comment": { /** - * Format: uri * @description The API URL to get the discussion comment where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + * @format uri */ discussion_comment_url: string; }; /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ "secret-scanning-location-pull-request-title": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ pull_request_title_url: string; }; /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ "secret-scanning-location-pull-request-body": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ pull_request_body_url: string; }; /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ "secret-scanning-location-pull-request-comment": { /** - * Format: uri * @description The API URL to get the pull request comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ pull_request_comment_url: string; }; /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ "secret-scanning-location-pull-request-review": { /** - * Format: uri * @description The API URL to get the pull request review where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + * @format uri */ pull_request_review_url: string; }; /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ "secret-scanning-location-pull-request-review-comment": { /** - * Format: uri * @description The API URL to get the pull request review comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + * @format uri */ pull_request_review_comment_url: string; }; @@ -33456,8 +34687,9 @@ export interface components { "secret-scanning-push-protection-bypass": { reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** - * Format: date-time + * @nullable * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ expire_at: string | null; /** @description The token type this bypass is for. */ @@ -33470,13 +34702,15 @@ export interface components { /** @description The state of the scan. Either "completed", "running", or "pending" */ status: string; /** - * Format: date-time + * @nullable * @description The time that the scan was completed. Empty if the scan is running + * @format date-time */ completed_at: string | null; /** - * Format: date-time + * @nullable * @description The time that the scan was started. Empty if the scan is pending + * @format date-time */ started_at: string | null; }; @@ -33496,37 +34730,62 @@ export interface components { summary: string; /** @description A detailed description of what the advisory impacts. */ description: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ vulnerabilities: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ credits?: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33539,29 +34798,51 @@ export interface components { summary: string; /** @description A detailed description of what the advisory impacts. */ description: string; - /** @description An array of products affected by the vulnerability detailed in a repository security advisory. */ + /** + * @nullable + * @description An array of products affected by the vulnerability detailed in a repository security advisory. + */ vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[] | null; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33574,46 +34855,77 @@ export interface components { summary: string; /** @description A detailed description of what the advisory impacts. */ description: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ vulnerabilities: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids: string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ credits: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string: string | null; /** * @description The state of the advisory. * @enum {string} */ state: "published" | "closed" | "draft"; - /** @description A list of usernames who have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of usernames who have been granted write access to the advisory. + */ collaborating_users: string[] | null; - /** @description A list of team slugs which have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of team slugs which have been granted write access to the advisory. + */ collaborating_teams: string[] | null; }; /** @@ -33621,7 +34933,7 @@ export interface components { * @description Stargazer */ stargazer: { - /** Format: date-time */ + /** @format date-time */ starred_at: string; user: components["schemas"]["nullable-simple-user"]; }; @@ -33694,20 +35006,21 @@ export interface components { subscribed: boolean; /** @description Determines if all notifications should be blocked from this repository. */ ignored: boolean; + /** @nullable */ reason: string | null; /** - * Format: date-time * @example 2012-10-06T21:34:12Z + * @format date-time */ created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/subscription + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; }; @@ -33720,17 +35033,17 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** - * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 + * @format uri */ zipball_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 + * @format uri */ tarball_url: string; node_id: string; @@ -33760,7 +35073,7 @@ export interface components { }; /** Traffic */ traffic: { - /** Format: date-time */ + /** @format date-time */ timestamp: string; uniques: number; count: number; @@ -33816,6 +35129,7 @@ export interface components { /** Search Result Text Matches */ "search-result-text-matches": { object_url: string; + /** @nullable */ object_type: string | null; property: string; fragment: string; @@ -33832,17 +35146,18 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; repository: components["schemas"]["minimal-repository"]; score: number; file_size?: number; + /** @nullable */ language?: string | null; - /** Format: date-time */ + /** @format date-time */ last_modified_at?: string; /** * @example [ @@ -33858,18 +35173,18 @@ export interface components { * @description Commit Search Result Item */ "commit-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { name: string; email: string; - /** Format: date-time */ + /** @format date-time */ date: string; }; committer: components["schemas"]["nullable-git-user"]; @@ -33877,10 +35192,10 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification?: components["schemas"]["verification"]; }; @@ -33901,34 +35216,37 @@ export interface components { * @description Issue Search Result Item */ "issue-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; number: number; title: string; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; user: components["schemas"]["nullable-simple-user"]; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; name: string; color: string; default: boolean; + /** @nullable */ description: string | null; }[]; /** Sub-issues Summary */ @@ -33938,27 +35256,46 @@ export interface components { percent_completed: number; }; state: string; + /** @nullable */ state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; milestone: components["schemas"]["nullable-milestone"]; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; body?: string; @@ -33968,7 +35305,7 @@ export interface components { repository?: components["schemas"]["repository"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -33980,11 +35317,12 @@ export interface components { "label-search-result-item": { id: number; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; name: string; color: string; default: boolean; + /** @nullable */ description: string | null; score: number; text_matches?: components["schemas"]["search-result-text-matches"]; @@ -34000,58 +35338,63 @@ export interface components { full_name: string; owner: components["schemas"]["nullable-simple-user"]; private: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; + /** @nullable */ description: string | null; fork: boolean; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ pushed_at: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ homepage: string | null; size: number; stargazers_count: number; watchers_count: number; + /** @nullable */ language: string | null; forks_count: number; open_issues_count: number; master_branch?: string; default_branch: string; score: number; - /** Format: uri */ + /** @format uri */ forks_url: string; keys_url: string; collaborators_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; issue_events_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; assignees_url: string; branches_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; blobs_url: string; git_tags_url: string; git_refs_url: string; trees_url: string; statuses_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; commits_url: string; git_commits_url: string; @@ -34059,10 +35402,10 @@ export interface components { issue_comment_url: string; contents_url: string; compare_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; archive_url: string; - /** Format: uri */ + /** @format uri */ downloads_url: string; issues_url: string; pulls_url: string; @@ -34070,18 +35413,21 @@ export interface components { notifications_url: string; labels_url: string; releases_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; git_url: string; ssh_url: string; clone_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; forks: number; open_issues: number; watchers: number; topics?: string[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; has_issues: boolean; has_projects: boolean; @@ -34120,22 +35466,32 @@ export interface components { */ "topic-search-result-item": { name: string; + /** @nullable */ display_name: string | null; + /** @nullable */ short_description: string | null; + /** @nullable */ description: string | null; + /** @nullable */ created_by: string | null; + /** @nullable */ released: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; featured: boolean; curated: boolean; score: number; + /** @nullable */ repository_count?: number | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ logo_url?: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ related?: { topic_relation: { id: number; @@ -34144,6 +35500,7 @@ export interface components { relation_type: string; }; }[] | null; + /** @nullable */ aliases?: { topic_relation: { id: number; @@ -34159,25 +35516,26 @@ export interface components { */ "user-search-result-item": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; score: number; @@ -34189,21 +35547,33 @@ export interface components { public_gists?: number; followers?: number; following?: number; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; + /** @nullable */ name?: string | null; + /** @nullable */ bio?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; + /** @nullable */ location?: string | null; site_admin: boolean; + /** @nullable */ hireable?: boolean | null; text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ blog?: string | null; + /** @nullable */ company?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at?: string | null; user_view_type?: string; }; @@ -34215,8 +35585,8 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -34227,25 +35597,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -34255,52 +35628,73 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ type: string; site_admin: boolean; - /** @example monalisa octocat */ + /** + * @nullable + * @example monalisa octocat + */ name: string | null; - /** @example GitHub */ + /** + * @nullable + * @example GitHub + */ company: string | null; - /** @example https://github.com/blog */ + /** + * @nullable + * @example https://github.com/blog + */ blog: string | null; - /** @example San Francisco */ + /** + * @nullable + * @example San Francisco + */ location: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ email: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ notification_email?: string | null; + /** @nullable */ hireable: boolean | null; - /** @example There once was... */ + /** + * @nullable + * @example There once was... + */ bio: string | null; - /** @example monalisa */ + /** + * @nullable + * @example monalisa + */ twitter_username?: string | null; /** @example 2 */ public_repos: number; @@ -34311,13 +35705,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ updated_at: string; /** @example 81 */ @@ -34352,13 +35746,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -34367,9 +35761,9 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/user/secrets/SECRET_NAME/repositories + * @format uri */ selected_repositories_url: string; }; @@ -34395,22 +35789,26 @@ export interface components { */ "codespace-export-details": { /** + * @nullable * @description State of the latest export * @example succeeded | failed | in_progress */ state: string | null; /** - * Format: date-time + * @nullable * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z + * @format date-time */ completed_at: string | null; /** + * @nullable * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ branch: string | null; /** + * @nullable * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ @@ -34426,6 +35824,7 @@ export interface components { */ export_url: string; /** + * @nullable * @description Web url for the exported branch * @example https://github.com/octocat/hello-world/tree/:branch */ @@ -34437,8 +35836,8 @@ export interface components { */ "codespace-with-full-repository": { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -34447,11 +35846,13 @@ export interface components { */ name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -34461,29 +35862,31 @@ export interface components { repository: components["schemas"]["full-repository"]; machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ last_used_at: string; /** @@ -34493,8 +35896,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -34526,60 +35929,77 @@ export interface components { */ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ allowed_port_privacy_settings: string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ retention_expires_at?: string | null; }; @@ -34589,15 +36009,18 @@ export interface components { */ email: { /** - * Format: email * @example octocat@github.com + * @format email */ email: string; /** @example true */ primary: boolean; /** @example true */ verified: boolean; - /** @example public */ + /** + * @nullable + * @example public + */ visibility: string | null; }; /** @@ -34606,12 +36029,16 @@ export interface components { */ "gpg-key": { /** - * Format: int64 * @example 3 + * @format int64 */ id: number; - /** @example Octocat's GPG Key */ + /** + * @nullable + * @example Octocat's GPG Key + */ name?: string | null; + /** @nullable */ primary_key_id: number | null; /** @example 3262EFF25BA0D270 */ key_id: string; @@ -34648,7 +36075,7 @@ export interface components { * ] */ subkeys: { - /** Format: int64 */ + /** @format int64 */ id: number; primary_key_id: number; key_id: string; @@ -34663,7 +36090,9 @@ export interface components { can_encrypt_storage: boolean; can_certify: boolean; created_at: string; + /** @nullable */ expires_at: string | null; + /** @nullable */ raw_key: string | null; revoked: boolean; }[]; @@ -34674,14 +36103,18 @@ export interface components { /** @example true */ can_certify: boolean; /** - * Format: date-time * @example 2016-03-24T11:31:04-06:00 + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; /** @example true */ revoked: boolean; + /** @nullable */ raw_key: string | null; }; /** @@ -34690,26 +36123,32 @@ export interface components { */ key: { key: string; - /** Format: int64 */ + /** @format int64 */ id: number; url: string; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; verified: boolean; read_only: boolean; }; /** Marketplace Account */ "marketplace-account": { - /** Format: uri */ + /** @format uri */ url: string; id: number; type: string; node_id?: string; login: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ organization_billing_email?: string | null; }; /** @@ -34720,21 +36159,25 @@ export interface components { /** @example monthly */ billing_cycle: string; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ next_billing_date: string | null; + /** @nullable */ unit_count: number | null; /** @example true */ on_free_trial: boolean; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ free_trial_ends_on: string | null; /** - * Format: date-time + * @nullable * @example 2017-11-02T01:12:12Z + * @format date-time */ updated_at: string | null; account: components["schemas"]["marketplace-account"]; @@ -34758,7 +36201,7 @@ export interface components { key: string; id: number; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; }; /** @@ -34766,7 +36209,7 @@ export interface components { * @description Starred Repository */ "starred-repository": { - /** Format: date-time */ + /** @format date-time */ starred_at: string; repo: components["schemas"]["repository"]; }; @@ -34795,9 +36238,11 @@ export interface components { inclusionPromise: { signedEntryTimestamp: string; }; + /** @nullable */ inclusionProof: string | null; canonicalizedBody: string; }[]; + /** @nullable */ timestampVerificationData: string | null; }; dsseEnvelope: { @@ -34834,16 +36279,20 @@ export interface components { * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." */ "enterprise-webhooks": { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -34864,16 +36313,18 @@ export interface components { */ slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** @@ -34907,18 +36358,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -34931,7 +36382,10 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; }; /** @@ -34941,9 +36395,9 @@ export interface components { */ "repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -34972,16 +36426,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -35003,28 +36460,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -35046,13 +36503,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -35066,30 +36523,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -35097,25 +36554,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -35190,18 +36650,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -35210,6 +36673,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id: number; node_id: string; @@ -35456,7 +36920,7 @@ export interface components { authorized_actors_only: boolean; authorized_dismissal_actors_only: boolean; create_protected?: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; dismiss_stale_reviews_on_push: boolean; id: number; @@ -35490,24 +36954,34 @@ export interface components { /** @enum {string} */ signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; strict_required_status_checks_policy: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ after: string | null; app: components["schemas"]["integration"]; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ before: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that is being checked. @@ -35525,7 +36999,7 @@ export interface components { * @enum {string} */ status: "queued" | "in_progress" | "completed" | "pending" | "waiting"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ url: string; @@ -35538,11 +37012,13 @@ export interface components { app: components["schemas"]["nullable-integration"]; check_suite: components["schemas"]["simple-check-suite"]; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ completed_at: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ @@ -35573,16 +37049,19 @@ export interface components { node_id: string; output: { annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; + /** @nullable */ summary: string | null; + /** @nullable */ text: string | null; + /** @nullable */ title: string | null; }; pull_requests: components["schemas"]["pull-request-minimal"][]; /** - * Format: date-time * @example 2018-05-04T01:14:52Z + * @format date-time */ started_at: string; /** @@ -35604,34 +37083,39 @@ export interface components { webhooks_ref_0: string; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ webhooks_deploy_key: { + /** @nullable */ added_by?: string | null; created_at: string; id: number; key: string; + /** @nullable */ last_used?: string | null; read_only: boolean; title: string; - /** Format: uri */ + /** @format uri */ url: string; verified: boolean; enabled?: boolean; }; - /** Workflow */ + /** + * Workflow + * @nullable + */ webhooks_workflow: { - /** Format: uri */ + /** @format uri */ badge_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; node_id: string; path: string; state: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; webhooks_approver: { @@ -35656,92 +37140,102 @@ export interface components { user_view_type: string; }; webhooks_reviewers: { - /** User */ + /** + * User + * @nullable + */ reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @enum {string} */ type: "User"; }[]; webhooks_workflow_job_run: { + /** @nullable */ conclusion: unknown; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: unknown; status: string; updated_at: string; }; - /** User */ + /** + * User + * @nullable + */ webhooks_user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35754,12 +37248,13 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; child_comment_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; discussion_id: number; html_url: string; id: number; node_id: string; + /** @nullable */ parent_id: unknown; /** Reactions */ reactions?: { @@ -35772,48 +37267,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35823,46 +37322,53 @@ export interface components { * @description A Discussion in a repository. */ discussion: { + /** @nullable */ active_lock_reason: string | null; + /** @nullable */ answer_chosen_at: string | null; - /** User */ + /** + * User + * @nullable + */ answer_chosen_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ answer_html_url: string | null; /** * AuthorAssociation @@ -35872,7 +37378,7 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; category: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -35885,7 +37391,7 @@ export interface components { updated_at: string; }; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; html_url: string; id: number; @@ -35903,7 +37409,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; @@ -35915,6 +37421,7 @@ export interface components { */ state: "open" | "closed" | "locked" | "converting" | "transferring"; /** + * @nullable * @description The reason for the current state * @example resolved * @enum {string|null} @@ -35922,44 +37429,48 @@ export interface components { state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; timeline_url?: string; title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35979,6 +37490,7 @@ export interface components { html_url: string; id: number; node_id: string; + /** @nullable */ parent_id: number | null; /** Reactions */ reactions: { @@ -35991,47 +37503,51 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36041,14 +37557,15 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }; @@ -36092,16 +37609,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: components["schemas"]["integration"]; @@ -36116,52 +37633,56 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36178,80 +37699,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ webhooks_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -36261,95 +37790,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36362,67 +37910,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36501,19 +38064,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -36527,10 +38096,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -36543,54 +38112,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36600,56 +38174,67 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36662,9 +38247,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -36672,80 +38257,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ webhooks_issue_2: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -36755,95 +38348,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36856,67 +38468,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36995,19 +38622,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -37021,10 +38654,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -37037,93 +38670,102 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** User */ + /** + * User + * @nullable + */ webhooks_user_mannequin: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -37133,11 +38775,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date: string | null; on_free_trial: boolean; plan: { @@ -37149,6 +38794,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -37160,11 +38806,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: unknown; + /** @nullable */ next_billing_date?: string | null; on_free_trial: boolean; plan: { @@ -37176,6 +38825,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -37187,25 +38837,32 @@ export interface components { */ webhooks_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -37219,12 +38876,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -37234,12 +38891,12 @@ export interface components { privacy?: "open" | "closed" | "secret"; /** @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -37260,14 +38917,15 @@ export interface components { }; /** * Repository + * @nullable * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -37296,16 +38954,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -37327,28 +38988,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -37370,13 +39031,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -37390,30 +39051,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -37421,25 +39082,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -37514,18 +39178,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -37534,6 +39201,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id: number; node_id: string; @@ -37771,56 +39439,67 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone_3: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -37833,9 +39512,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -37843,48 +39522,52 @@ export interface components { * @description The membership between the user and the organization. Not present when the action is `member_invited`. */ webhooks_membership: { - /** Format: uri */ + /** @format uri */ organization_url: string; role: string; state: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -37938,9 +39621,15 @@ export interface components { * @enum {string} */ repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ repositories: { full_name: string; /** @description Unique identifier of the repository */ @@ -37959,154 +39648,174 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** Project Card */ webhooks_project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project */ webhooks_project: { - /** @description Body of the project */ + /** + * @nullable + * @description Body of the project + */ body: string | null; - /** Format: uri */ + /** @format uri */ columns_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Name of the project */ name: string; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ owner_url: string; /** * @description State of the project; either 'open' or 'closed' * @enum {string} */ state: "open" | "closed"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project Column */ webhooks_project_column: { + /** @nullable */ after_id?: number | null; - /** Format: uri */ + /** @format uri */ cards_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The unique identifier of the project column */ id: number; /** @description Name of the project column */ name: string; node_id: string; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -38119,37 +39828,47 @@ export interface components { owner: components["schemas"]["simple-user"]; creator: components["schemas"]["simple-user"]; title: string; + /** @nullable */ description: string | null; public: boolean; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; number: number; + /** @nullable */ short_description: string | null; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ deleted_at: string | null; deleted_by: components["schemas"]["nullable-simple-user"]; }; webhooks_project_changes: { archived_at: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ from: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ to: string | null; }; }; @@ -38171,18 +39890,19 @@ export interface components { content_type: components["schemas"]["projects-v2-item-content-type"]; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ archived_at: string | null; }; @@ -38193,7 +39913,9 @@ export interface components { "projects-v2-single-select-option": { id: string; name: string; + /** @nullable */ color?: string | null; + /** @nullable */ description?: string | null; }; /** @@ -38203,7 +39925,9 @@ export interface components { "projects-v2-iteration-setting": { id: string; title: string; + /** @nullable */ duration?: number | null; + /** @nullable */ start_date?: string | null; }; /** @@ -38216,28 +39940,32 @@ export interface components { project_node_id?: string; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** - * Format: date * @example 2022-04-28 + * @format date */ start_date?: string; /** - * Format: date * @example 2022-04-28 + * @format date */ target_date?: string; /** + * @nullable * @description Body of the status update * @example The project is off to a great start! */ @@ -38299,120 +40027,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -38423,48 +40159,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -38505,32 +40252,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -38540,28 +40287,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -38589,37 +40337,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -38640,55 +40396,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -38702,11 +40465,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -38729,26 +40494,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -38763,60 +40528,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -38851,32 +40624,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -38886,28 +40659,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -38935,37 +40709,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -38986,55 +40768,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39048,11 +40837,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -39075,26 +40866,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -39109,168 +40900,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -39283,73 +41101,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -39358,12 +41185,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -39371,36 +41198,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -39409,12 +41243,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -39422,69 +41256,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39497,17 +41335,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -39521,20 +41359,23 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; @@ -39544,17 +41385,26 @@ export interface components { original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -39568,7 +41418,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -39576,9 +41426,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -39589,49 +41443,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39641,12 +41499,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -39656,60 +41514,71 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; state: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ submitted_at: string | null; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ webhooks_nullable_string: string | null; /** * Release @@ -39717,13 +41586,14 @@ export interface components { */ webhooks_release: { assets: { - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -39734,103 +41604,119 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; }[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -39843,20 +41729,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; /** @@ -39865,13 +41757,14 @@ export interface components { */ webhooks_release_1: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -39882,103 +41775,119 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -39991,20 +41900,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; /** @@ -40017,48 +41932,55 @@ export interface components { created_at: string; dismiss_reason?: string; dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -40070,6 +41992,7 @@ export interface components { state: "open"; }; /** + * @nullable * @description The reason for resolving the alert. * @enum {string|null} */ @@ -40081,18 +42004,22 @@ export interface components { url: components["schemas"]["alert-url"]; html_url: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url: string; resolution: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at: string | null; resolved_by: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ resolution_comment: string | null; /** @description The type of secret that secret scanning detected. */ secret_type: string; @@ -40106,33 +42033,51 @@ export interface components { * @enum {string} */ validity: "active" | "inactive" | "unknown"; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed: boolean | null; push_protection_bypassed_by: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at: string | null; push_protection_bypass_request_reviewer: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url: string | null; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ publicly_leaked: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or business. + */ multi_repo: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { cvss: { score: number; + /** @nullable */ vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -40148,13 +42093,14 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; summary: string; updated_at: string; vulnerabilities: { + /** @nullable */ first_patched_version: { identifier: string; } | null; @@ -40165,6 +42111,7 @@ export interface components { severity: string; vulnerable_version_range: string; }[]; + /** @nullable */ withdrawn_at: string | null; }; webhooks_sponsorship: { @@ -40192,79 +42139,87 @@ export interface components { }; node_id: string; privacy_level: string; - /** User */ + /** + * User + * @nullable + */ sponsor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** User */ + /** + * User + * @nullable + */ sponsorable: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40311,25 +42266,32 @@ export interface components { */ webhooks_team_1: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -40343,12 +42305,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -40361,12 +42323,12 @@ export interface components { * @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -40419,15 +42381,18 @@ export interface components { /** @description If the action was `edited`, the changes to the rule. */ changes?: { admin_enforced: { + /** @nullable */ from: boolean | null; }; authorized_actor_names: { from: string[]; }; authorized_actors_only: { + /** @nullable */ from: boolean | null; }; authorized_dismissal_actors_only: { + /** @nullable */ from: boolean | null; }; linear_history_requirement_enforcement_level: { @@ -40439,6 +42404,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; lock_allows_fork_sync: { + /** @nullable */ from: boolean | null; }; pull_request_reviews_enforcement_level: { @@ -40446,6 +42412,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; require_last_push_approval: { + /** @nullable */ from: boolean | null; }; required_status_checks: { @@ -40546,63 +42513,81 @@ export interface components { action: "completed"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description The client ID of the GitHub app */ + /** + * @nullable + * @description The client ID of the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40681,20 +42666,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -40703,9 +42696,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40716,9 +42712,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40742,7 +42741,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -40753,28 +42752,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -40790,63 +42790,81 @@ export interface components { action: "requested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description Client ID of the GitHub app */ + /** + * @nullable + * @description Client ID of the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40925,20 +42943,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -40947,9 +42973,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40960,9 +42989,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40986,7 +43018,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -40997,28 +43029,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -41034,63 +43067,81 @@ export interface components { action: "rerequested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description The Client ID for the GitHub app */ + /** + * @nullable + * @description The Client ID for the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -41169,20 +43220,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -41191,9 +43250,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -41204,9 +43266,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -41230,7 +43295,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -41241,28 +43306,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -41279,67 +43345,79 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41375,12 +43453,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41388,10 +43468,13 @@ export interface components { tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41409,67 +43492,78 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41503,17 +43597,23 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** @@ -41522,13 +43622,17 @@ export interface components { */ state: "dismissed" | "fixed"; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41546,25 +43650,39 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time + * @nullable * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: unknown; + /** @nullable */ dismissed_by: unknown; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41598,33 +43716,46 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | null; + /** @nullable */ tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; } | null; + /** @nullable */ updated_at?: string | null; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41642,69 +43773,81 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41738,32 +43881,43 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "fixed" | null; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41778,27 +43932,43 @@ export interface components { "webhook-code-scanning-alert-reopened": { /** @enum {string} */ action: "reopened"; - /** @description The code scanning alert involved in the event. */ + /** + * @nullable + * @description The code scanning alert involved in the event. + */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: string | null; + /** @nullable */ dismissed_by: Record | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: string | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41832,40 +44002,57 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | "fixed" | null; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; } | null; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ commit_oid: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -41877,24 +44064,37 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: unknown; + /** @nullable */ dismissed_by: unknown; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41930,12 +44130,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41943,10 +44145,13 @@ export interface components { tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41977,17 +44182,26 @@ export interface components { /** @description The SHA of the commit to which the comment applies. */ commit_id: string; created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The ID of the commit comment. */ id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the commit comment. */ node_id: string; - /** @description The relative path of the file to which the comment applies. */ + /** + * @nullable + * @description The relative path of the file to which the comment applies. + */ path: string | null; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; /** Reactions */ reactions?: { @@ -42000,48 +44214,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42054,7 +44272,10 @@ export interface components { }; /** create event */ "webhook-create": { - /** @description The repository's current description. */ + /** + * @nullable + * @description The repository's current description. + */ description: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; @@ -42242,44 +44463,49 @@ export interface components { */ deployment: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; environment: string; id: number; @@ -42288,58 +44514,73 @@ export interface components { payload: Record | string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42418,20 +44659,23 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -42440,43 +44684,50 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42485,13 +44736,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: unknown; head_repository?: { archive_url: string; @@ -42505,6 +44760,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: unknown; downloads_url: string; events_url: string; @@ -42561,7 +44817,7 @@ export interface components { url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -42569,6 +44825,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: unknown; pull_requests: { base: { @@ -42577,7 +44834,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -42588,16 +44845,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -42615,6 +44873,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: unknown; downloads_url: string; events_url: string; @@ -42673,51 +44932,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -42732,8 +44995,8 @@ export interface components { /** @description The event that triggered the deployment protection rule. */ event: string; /** - * Format: uri * @description The URL to review the deployment protection rule. + * @format uri */ deployment_callback_url: string; deployment: components["schemas"]["deployment"]; @@ -42757,52 +45020,61 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { + /** @nullable */ conclusion: unknown; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: string | null; status: string; updated_at: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42811,13 +45083,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url: string; @@ -42831,6 +45107,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: string | null; downloads_url: string; events_url: string; @@ -42888,7 +45165,7 @@ export interface components { url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -42896,6 +45173,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -42904,7 +45182,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -42915,16 +45193,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -42942,6 +45221,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: string | null; downloads_url: string; events_url: string; @@ -43001,51 +45281,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43065,52 +45349,61 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { + /** @nullable */ conclusion: string | null; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: string | null; status: string; updated_at: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43119,12 +45412,16 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url: string; @@ -43138,6 +45435,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: string | null; downloads_url: string; events_url: string; @@ -43195,7 +45493,7 @@ export interface components { url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -43203,6 +45501,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -43211,7 +45510,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -43222,16 +45521,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -43249,6 +45549,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: string | null; downloads_url: string; events_url: string; @@ -43308,51 +45609,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43369,41 +45674,45 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; requestor: components["schemas"]["webhooks_user"]; reviewers: { - /** User */ + /** + * User + * @nullable + */ reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43413,52 +45722,61 @@ export interface components { sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { + /** @nullable */ conclusion: unknown; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: string | null; status: string; updated_at: string; }; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43467,12 +45785,16 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url: string; @@ -43486,6 +45808,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: string | null; downloads_url: string; events_url: string; @@ -43543,7 +45866,7 @@ export interface components { url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -43551,6 +45874,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -43559,7 +45883,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -43570,16 +45894,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -43597,6 +45922,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: string | null; downloads_url: string; events_url: string; @@ -43656,51 +45982,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43711,34 +46041,39 @@ export interface components { "webhook-deployment-status-created": { /** @enum {string} */ action: "created"; + /** @nullable */ check_run?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ completed_at: string | null; /** + * @nullable * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ + /** @format uri */ details_url: string; external_id: string; /** @description The SHA of the commit that is being checked. */ head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The id of the check. */ id: number; /** @description The name of the check run. */ name: string; node_id: string; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ + /** @format uri */ url: string; } | null; /** @@ -43747,104 +46082,125 @@ export interface components { */ deployment: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; environment: string; id: number; node_id: string; original_environment: string; + /** @nullable */ payload: (string | Record) | null; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43923,128 +46279,150 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ deployment_url: string; /** @description The optional human-readable description added to the status. */ description: string; environment: string; - /** Format: uri */ + /** @format uri */ environment_url?: string; id: number; - /** Format: uri */ + /** @format uri */ log_url?: string; node_id: string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44123,17 +46501,20 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; - /** Format: uri */ + /** @format uri */ repository_url: string; /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ state: string; /** @description The optional link added to the status. */ target_url: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -44142,43 +46523,50 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run?: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44187,13 +46575,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: unknown; head_repository?: { archive_url: string; @@ -44207,6 +46599,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: unknown; downloads_url: string; events_url: string; @@ -44263,7 +46656,7 @@ export interface components { url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -44271,6 +46664,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: unknown; pull_requests: { base: { @@ -44279,7 +46673,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -44290,16 +46684,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -44317,6 +46712,7 @@ export interface components { contents_url: string; contributors_url: string; deployments_url: string; + /** @nullable */ description: unknown; downloads_url: string; events_url: string; @@ -44375,51 +46771,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -44444,7 +46844,7 @@ export interface components { changes: { category: { from: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -44693,32 +47093,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -44728,28 +47128,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -44772,89 +47173,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44868,36 +47284,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -44922,6 +47340,7 @@ export interface components { created_at?: string; default_branch?: string; deployments_url?: string; + /** @nullable */ description?: string | null; disabled?: boolean; downloads_url?: string; @@ -44941,6 +47360,7 @@ export interface components { has_pages?: boolean; has_projects?: boolean; has_wiki?: boolean; + /** @nullable */ homepage?: string | null; hooks_url?: string; html_url?: string; @@ -44951,11 +47371,14 @@ export interface components { issues_url?: string; keys_url?: string; labels_url?: string; + /** @nullable */ language?: unknown; languages_url?: string; + /** @nullable */ license?: Record | null; merges_url?: string; milestones_url?: string; + /** @nullable */ mirror_url?: unknown; name?: string; node_id?: string; @@ -45029,14 +47452,15 @@ export interface components { */ action: "created" | "edited"; /** - * Format: uri * @description Points to the HTML wiki page. + * @format uri */ html_url: string; /** @description The name of the page. */ page_name: string; /** @description The latest commit SHA of the page. */ sha: string; + /** @nullable */ summary: string | null; /** @description The current page title. */ title: string; @@ -45065,6 +47489,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45077,6 +47502,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45137,14 +47563,17 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { + /** @nullable */ archived_at?: string | null; avatar_url: string; created_at?: string; + /** @nullable */ description?: unknown; events_url?: string; followers?: number; @@ -45177,6 +47606,7 @@ export interface components { type?: string; updated_at?: string; url?: string; + /** @nullable */ website_url?: unknown; user_view_type?: string; }; @@ -45206,6 +47636,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45226,16 +47657,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -45250,52 +47681,56 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45304,80 +47739,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -45387,95 +47830,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -45488,67 +47950,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45627,19 +48104,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -45653,10 +48136,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -45669,100 +48152,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -45774,22 +48269,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1": number; @@ -45821,7 +48319,7 @@ export interface components { gists_url: string; gravatar_id: string; html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; node_id: string; @@ -45848,80 +48346,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -45931,95 +48437,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -46032,67 +48557,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46171,19 +48711,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -46197,10 +48743,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -46213,100 +48759,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -46318,22 +48876,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1": number; @@ -46365,7 +48926,7 @@ export interface components { gists_url: string; gravatar_id: string; html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; node_id: string; @@ -46394,80 +48955,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -46477,95 +49046,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -46578,67 +49166,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46717,19 +49320,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -46743,10 +49352,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -46759,100 +49368,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -46864,22 +49485,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1": number; @@ -46911,7 +49535,7 @@ export interface components { gists_url: string; gravatar_id: string; html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; node_id: string; @@ -46955,80 +49579,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -47038,95 +49670,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -47139,67 +49790,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47278,19 +49944,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -47304,10 +49976,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -47320,63 +49992,72 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; + /** @nullable */ assignee?: Record | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at: string | null; comments?: number; comments_url?: string; @@ -47387,9 +50068,11 @@ export interface components { labels?: (Record | null)[]; labels_url?: string; locked?: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1": number; @@ -47418,7 +50101,7 @@ export interface components { gists_url: string; gravatar_id: string; html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; node_id: string; @@ -47448,80 +50131,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -47530,95 +50221,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -47631,67 +50341,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47770,19 +50495,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -47796,10 +50527,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -47812,54 +50543,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47879,79 +50615,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -47960,95 +50704,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48061,67 +50824,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48200,19 +50978,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -48226,10 +51010,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -48242,54 +51026,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48321,80 +51110,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -48403,95 +51200,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48504,67 +51320,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48643,19 +51474,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -48669,10 +51506,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -48685,54 +51522,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48753,80 +51595,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -48835,95 +51685,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48936,67 +51805,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49075,19 +51959,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -49101,10 +51991,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49117,54 +52007,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49185,80 +52080,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -49268,96 +52171,115 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: true; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -49370,67 +52292,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49509,19 +52446,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -49535,10 +52478,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49551,54 +52494,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49618,79 +52566,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -49699,95 +52655,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -49800,67 +52775,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49939,19 +52929,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -49965,10 +52961,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49981,54 +52977,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50045,83 +53046,92 @@ export interface components { changes?: { /** * Issue + * @nullable * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ old_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50131,95 +53141,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50232,67 +53261,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50371,19 +53415,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -50397,10 +53447,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -50413,54 +53463,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50493,32 +53548,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -50532,28 +53587,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** @description Whether the repository has discussions enabled. */ has_discussions?: boolean; @@ -50578,89 +53634,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50674,36 +53745,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -50720,80 +53793,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50803,95 +53884,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50904,67 +54004,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51043,19 +54158,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -51069,10 +54190,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51085,54 +54206,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51163,79 +54289,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -51244,95 +54378,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51345,67 +54498,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51484,19 +54652,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -51510,10 +54684,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51526,54 +54700,59 @@ export interface components { * @enum {string} */ state: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51592,80 +54771,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ new_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -51675,95 +54862,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51776,67 +54982,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51915,19 +55136,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -51941,10 +55168,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51957,54 +55184,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52037,32 +55269,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -52076,28 +55308,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -52125,89 +55358,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52221,36 +55469,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -52305,80 +55555,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -52388,96 +55646,115 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: false; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -52490,67 +55767,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52629,19 +55921,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** Format: uri */ + /** @format uri */ patch_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Reactions */ @@ -52655,10 +55953,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -52671,54 +55969,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52814,12 +56117,16 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date?: string | null; + /** @nullable */ on_free_trial: boolean | null; plan: { bullets: string[]; @@ -52830,6 +56137,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52853,11 +56161,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date?: string | null; on_free_trial: boolean; plan: { @@ -52869,6 +56180,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52890,11 +56202,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: unknown; + /** @nullable */ next_billing_date: string | null; on_free_trial: boolean; plan: { @@ -52906,6 +56221,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52967,7 +56283,9 @@ export interface components { from: string; }; permission: { + /** @nullable */ from: string | null; + /** @nullable */ to: string | null; }; }; @@ -53003,41 +56321,45 @@ export interface components { * @enum {string} */ scope: "team"; - /** User */ + /** + * User + * @nullable + */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53057,41 +56379,45 @@ export interface components { * @enum {string} */ scope: "team" | "organization"; - /** User */ + /** + * User + * @nullable + */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53133,7 +56459,7 @@ export interface components { content_type: "json" | "form"; insecure_ssl: string; secret?: string; - /** Format: uri */ + /** @format uri */ url: string; }; created_at: string; @@ -53272,53 +56598,63 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ invitation: { - /** Format: date-time */ + /** @format date-time */ created_at: string; + /** @nullable */ email: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ failed_at: string | null; + /** @nullable */ failed_reason: string | null; id: number; - /** Format: uri */ + /** @format uri */ invitation_teams_url: string; - /** User */ + /** + * User + * @nullable + */ inviter: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ login: string | null; node_id: string; role: string; @@ -53385,96 +56721,110 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ package: { + /** @nullable */ created_at: string | null; + /** @nullable */ description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; package_type: string; + /** @nullable */ package_version: { - /** User */ + /** + * User + * @nullable + */ author?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; body?: string | Record; body_html?: string; + /** @nullable */ container_metadata?: { + /** @nullable */ labels: Record | null; + /** @nullable */ manifest: Record | null; tag: { digest: string; @@ -53487,7 +56837,7 @@ export interface components { tags: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -53496,22 +56846,27 @@ export interface components { [key: string]: unknown; }[]; name: string; + /** @nullable */ npm_metadata?: { name: string; version: string; npm_user: string; + /** @nullable */ author: Record | null; + /** @nullable */ bugs: Record | null; dependencies: Record; dev_dependencies: Record; peer_dependencies: Record; optional_dependencies: Record; description: string; + /** @nullable */ dist: Record | null; git_head: string; homepage: string; license: string; main: string; + /** @nullable */ repository: Record | null; scripts: Record; id: string; @@ -53525,6 +56880,7 @@ export interface components { files: string[]; bin: Record; man: Record; + /** @nullable */ directories: Record | null; os: string[]; cpu: string[]; @@ -53535,6 +56891,7 @@ export interface components { published_via_actions: boolean; deleted_by_id: number; } | null; + /** @nullable */ nuget_metadata?: { id: number | string; name: string; @@ -53548,69 +56905,78 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; + /** @nullable */ sha256: string | null; size: number; + /** @nullable */ state: string | null; updated_at: string; }[]; package_url?: string; prerelease?: boolean; release?: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; prerelease: boolean; published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; @@ -53622,15 +56988,17 @@ export interface components { updated_at?: string; version: string; } | null; + /** @nullable */ registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; + /** @nullable */ updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; @@ -53646,88 +57014,97 @@ export interface components { /** @description Information about the package. */ package: { created_at: string; + /** @nullable */ description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; package_type: string; package_version: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53739,7 +57116,7 @@ export interface components { tags: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -53751,11 +57128,13 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; sha256: string; size: number; @@ -53765,47 +57144,51 @@ export interface components { package_url?: string; prerelease?: boolean; release?: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; @@ -53813,11 +57196,11 @@ export interface components { published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - /** Format: uri */ + /** @format uri */ source_url?: string; summary: string; tag_name?: string; @@ -53826,12 +57209,13 @@ export interface components { updated_at: string; version: string; }; + /** @nullable */ registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; @@ -53844,53 +57228,59 @@ export interface components { "webhook-page-build": { /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ build: { + /** @nullable */ commit: string | null; created_at: string; duration: number; error: { + /** @nullable */ message: string | null; }; - /** User */ + /** + * User + * @nullable + */ pusher: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; status: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -53956,9 +57346,9 @@ export interface components { secret: components["schemas"]["webhook-config-secret"]; url: components["schemas"]["webhook-config-url"]; }; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ deliveries_url?: string; /** @description Determines what events the hook is triggered for. Default: ['push']. */ events: string[]; @@ -53970,14 +57360,14 @@ export interface components { * @enum {string} */ name: "web"; - /** Format: uri */ + /** @format uri */ ping_url?: string; - /** Format: uri */ + /** @format uri */ test_url?: string; type: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** @description The ID of the webhook that triggered the ping. */ @@ -54029,63 +57419,70 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; + /** @nullable */ column_id: number | null; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; @@ -54097,6 +57494,7 @@ export interface components { action: "edited"; changes: { note: { + /** @nullable */ from: string | null; }; }; @@ -54120,70 +57518,78 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } & { + /** @nullable */ after_id: number | null; archived?: boolean; column_id?: number; column_url?: string; created_at?: string; + /** @nullable */ creator?: { avatar_url: string; events_url: string; @@ -54206,6 +57612,7 @@ export interface components { } | null; id?: number; node_id?: string; + /** @nullable */ note?: string | null; project_url?: string; updated_at?: string; @@ -54362,7 +57769,9 @@ export interface components { action: "edited"; changes: { description: { + /** @nullable */ from: string | null; + /** @nullable */ to: string | null; }; public: { @@ -54370,7 +57779,9 @@ export interface components { to: boolean; }; short_description: { + /** @nullable */ from: string | null; + /** @nullable */ to: string | null; }; title: { @@ -54399,6 +57810,7 @@ export interface components { action: "converted"; changes: { content_type: { + /** @nullable */ from: string | null; to: string; }; @@ -54440,12 +57852,16 @@ export interface components { field_type: string; field_name: string; project_number: number; + /** @nullable */ from: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + /** @nullable */ to: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; }; } | { body: { + /** @nullable */ from: string | null; + /** @nullable */ to: string | null; }; }; @@ -54460,7 +57876,9 @@ export interface components { action: "reordered"; changes: { previous_projects_v2_item_node_id: { + /** @nullable */ from: string | null; + /** @nullable */ to: string | null; }; }; @@ -54512,25 +57930,45 @@ export interface components { action: "edited"; changes?: { body: { + /** @nullable */ from: string | null; + /** @nullable */ to: string | null; }; status: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ from: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ to: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; start_date: { - /** Format: date */ + /** + * @nullable + * @format date + */ from: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ to: string | null; }; target_date: { - /** Format: date */ + /** + * @nullable + * @format date + */ from: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ to: string | null; }; }; @@ -54561,120 +57999,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -54686,48 +58132,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54768,32 +58225,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -54803,28 +58260,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -54852,37 +58310,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -54903,55 +58369,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54965,11 +58438,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -54992,26 +58467,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55026,68 +58501,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -55114,32 +58599,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -55149,28 +58634,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -55198,37 +58684,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -55249,55 +58743,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55311,11 +58812,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -55338,26 +58841,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55372,168 +58875,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -55546,74 +59076,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -55622,12 +59161,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -55635,36 +59174,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -55673,12 +59219,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -55686,69 +59232,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55769,120 +59319,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -55893,48 +59451,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55975,32 +59544,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -56010,28 +59579,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -56059,37 +59629,45 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -56110,55 +59688,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56172,11 +59757,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -56199,26 +59786,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56233,60 +59820,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -56321,32 +59916,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -56356,28 +59951,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -56405,37 +60001,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -56456,55 +60060,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56518,11 +60129,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -56545,26 +60158,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56579,168 +60192,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -56753,74 +60393,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -56829,12 +60478,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -56842,36 +60491,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -56880,12 +60536,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -56893,69 +60549,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56977,120 +60637,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -57101,48 +60769,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57183,32 +60862,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -57218,28 +60897,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -57267,37 +60947,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -57318,55 +61006,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57380,11 +61075,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -57407,26 +61104,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57441,60 +61138,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -57529,32 +61234,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -57564,28 +61269,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -57613,34 +61319,42 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -57661,55 +61375,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57723,11 +61444,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -57750,26 +61473,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57784,168 +61507,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -57958,74 +61708,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -58034,12 +61793,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -58047,36 +61806,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -58085,12 +61851,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -58098,69 +61864,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58218,120 +61988,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -58342,48 +62120,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58424,32 +62213,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -58459,28 +62248,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -58508,37 +62298,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -58559,55 +62357,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58621,11 +62426,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -58648,26 +62455,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -58682,60 +62489,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -58770,32 +62585,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -58805,28 +62620,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -58854,37 +62670,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -58905,55 +62729,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58967,11 +62798,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -58994,26 +62827,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59028,168 +62861,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -59202,74 +63062,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59278,12 +63147,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59291,36 +63160,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59329,12 +63205,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59342,69 +63218,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59458,120 +63338,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -59582,48 +63470,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59664,32 +63563,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -59699,28 +63598,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -59748,37 +63648,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -59799,55 +63707,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59861,11 +63776,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -59888,26 +63805,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59922,60 +63839,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -60010,32 +63935,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60045,28 +63970,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60094,37 +64020,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -60145,55 +64079,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60207,11 +64148,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -60234,26 +64177,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -60268,168 +64211,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -60442,74 +64412,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -60518,12 +64497,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -60531,36 +64510,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -60569,12 +64555,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -60582,69 +64568,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60666,120 +64656,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -60790,48 +64788,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60872,32 +64881,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60907,28 +64916,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60956,37 +64966,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -61007,55 +65025,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61069,11 +65094,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -61096,26 +65123,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61130,68 +65157,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -61218,32 +65255,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -61253,28 +65290,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -61302,37 +65340,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -61353,55 +65399,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61415,11 +65468,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -61442,26 +65497,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61476,168 +65531,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -61650,74 +65732,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61726,12 +65817,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61739,36 +65830,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61777,12 +65875,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61790,69 +65888,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61873,120 +65975,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -61997,48 +66107,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62079,32 +66200,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -62114,28 +66235,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -62163,37 +66285,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -62214,55 +66344,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62276,11 +66413,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -62303,26 +66442,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62337,68 +66476,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -62425,32 +66574,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -62460,28 +66609,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -62509,37 +66659,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -62560,55 +66718,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62622,11 +66787,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -62649,26 +66816,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62683,168 +66850,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -62857,74 +67051,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62933,12 +67136,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62946,36 +67149,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62984,12 +67194,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62997,69 +67207,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63127,17 +67341,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -63151,40 +67365,55 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -63198,7 +67427,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -63206,9 +67435,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -63219,49 +67452,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63273,119 +67510,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -63396,48 +67641,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63478,32 +67734,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63513,28 +67769,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63562,37 +67819,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -63613,55 +67878,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63675,11 +67947,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -63702,26 +67976,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -63736,54 +68010,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -63791,6 +68071,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -63817,32 +68098,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63852,28 +68133,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63901,37 +68183,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -63952,55 +68242,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64014,11 +68311,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -64041,26 +68340,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64075,124 +68374,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -64205,72 +68523,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64279,12 +68605,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64292,36 +68618,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64330,12 +68663,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64343,63 +68676,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64419,119 +68756,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -64542,48 +68887,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64624,32 +68980,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -64659,28 +69015,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -64708,37 +69065,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -64759,55 +69124,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64821,11 +69193,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -64848,26 +69222,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64882,54 +69256,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -64937,6 +69317,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -64963,32 +69344,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -64998,28 +69379,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65047,37 +69429,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -65098,55 +69488,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65160,11 +69557,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -65187,26 +69586,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -65221,124 +69620,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -65351,72 +69769,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65425,12 +69851,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -65438,36 +69864,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65476,12 +69909,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -65489,63 +69922,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65566,119 +70003,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -65690,48 +70135,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65772,32 +70228,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -65807,28 +70263,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65856,37 +70313,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -65907,55 +70372,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65969,11 +70441,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -65996,26 +70470,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66030,54 +70504,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -66085,6 +70565,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -66111,32 +70592,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66146,28 +70627,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -66195,37 +70677,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -66246,55 +70736,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66308,11 +70805,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -66335,26 +70834,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66369,124 +70868,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -66499,72 +71017,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -66573,12 +71099,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -66586,36 +71112,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -66624,12 +71157,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -66637,64 +71170,68 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; user_view_type?: string; - /** Format: uri */ + /** @format uri */ url?: string; } | null; }; @@ -66713,119 +71250,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -66836,48 +71381,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66918,32 +71474,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66953,28 +71509,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -67002,37 +71559,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -67053,55 +71618,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67115,11 +71687,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -67142,26 +71716,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67176,54 +71750,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -67231,6 +71811,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -67257,32 +71838,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -67292,28 +71873,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -67341,37 +71923,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -67392,55 +71982,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67454,11 +72051,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -67481,26 +72080,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67515,124 +72114,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -67645,72 +72263,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67719,12 +72345,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67732,36 +72358,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67770,12 +72403,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67783,63 +72416,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67850,12 +72487,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -67865,57 +72502,64 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; /** @enum {string} */ state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ + /** @format date-time */ submitted_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67940,119 +72584,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -68063,48 +72715,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68145,32 +72808,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68180,28 +72843,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68224,89 +72888,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68320,36 +72999,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -68357,54 +73038,60 @@ export interface components { watchers_count: number; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -68412,6 +73099,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -68438,32 +73126,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68473,28 +73161,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68517,89 +73206,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68613,36 +73317,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -68650,124 +73356,143 @@ export interface components { watchers_count: number; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -68780,72 +73505,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68854,12 +73587,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68867,36 +73600,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68905,12 +73645,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68918,63 +73658,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68997,120 +73741,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -69122,48 +73874,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69204,32 +73967,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -69239,28 +74002,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -69288,37 +74052,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -69339,55 +74111,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69401,11 +74180,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -69421,26 +74202,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69455,60 +74236,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -69543,32 +74332,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -69578,28 +74367,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -69627,37 +74417,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -69678,55 +74476,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69740,11 +74545,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -69767,26 +74574,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69801,168 +74608,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -69975,74 +74809,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70051,12 +74894,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70064,36 +74907,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70102,12 +74952,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70115,109 +74965,117 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70235,120 +75093,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -70360,48 +75226,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70442,32 +75319,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70477,28 +75354,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70526,37 +75404,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -70577,55 +75463,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70639,11 +75532,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -70666,26 +75561,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -70700,60 +75595,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -70788,32 +75691,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70823,28 +75726,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70872,37 +75776,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -70923,55 +75835,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70985,11 +75904,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -71012,26 +75933,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71046,168 +75967,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -71220,74 +76168,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71296,12 +76253,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71309,36 +76266,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71347,12 +76311,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71360,69 +76324,73 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71434,25 +76402,32 @@ export interface components { */ requested_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71461,12 +76436,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71474,12 +76449,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }; @@ -71499,120 +76474,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -71624,48 +76607,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71706,32 +76700,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -71741,28 +76735,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -71790,37 +76785,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -71841,55 +76844,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71903,11 +76913,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -71930,26 +76942,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71964,60 +76976,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -72052,32 +77072,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72087,28 +77107,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -72136,37 +77157,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -72187,55 +77216,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72249,11 +77285,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -72276,26 +77314,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -72310,168 +77348,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -72484,74 +77549,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -72560,12 +77634,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -72573,36 +77647,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -72611,12 +77692,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -72624,109 +77705,117 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72744,120 +77833,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -72869,48 +77966,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72951,32 +78059,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72986,28 +78094,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73035,37 +78144,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -73086,55 +78203,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73148,11 +78272,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -73175,26 +78301,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73209,60 +78335,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -73297,32 +78431,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -73332,28 +78466,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73381,37 +78516,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -73432,55 +78575,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73494,11 +78644,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -73521,26 +78673,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73555,168 +78707,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -73729,74 +78908,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73805,12 +78993,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73818,36 +79006,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73856,12 +79051,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73869,69 +79064,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73943,25 +79142,32 @@ export interface components { */ requested_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73970,12 +79176,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73983,12 +79189,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -74006,119 +79212,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -74129,48 +79343,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74211,32 +79436,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -74246,28 +79471,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -74295,37 +79521,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -74346,55 +79580,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74408,11 +79649,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -74435,26 +79678,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74469,61 +79712,69 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -74550,32 +79801,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -74585,28 +79836,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -74634,37 +79886,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -74685,55 +79945,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74747,11 +80014,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -74774,26 +80043,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74808,124 +80077,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -74938,72 +80226,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75012,12 +80308,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75025,36 +80321,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75063,12 +80366,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75076,63 +80379,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75153,119 +80460,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -75276,48 +80591,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75358,32 +80684,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75393,28 +80719,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -75442,89 +80769,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75538,36 +80880,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -75577,61 +80921,69 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -75658,32 +81010,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75693,28 +81045,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -75742,89 +81095,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75838,36 +81206,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -75877,124 +81247,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -76007,72 +81396,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76081,12 +81478,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76094,36 +81491,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76132,12 +81536,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76145,63 +81549,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76213,17 +81621,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -76237,40 +81645,55 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -76284,7 +81707,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -76292,9 +81715,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -76305,49 +81732,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76367,119 +81798,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -76490,48 +81929,56 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; /** @description Title for the merge commit message. */ commit_title: string; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76572,32 +82019,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -76607,28 +82054,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76656,89 +82104,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76752,36 +82215,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -76791,54 +82256,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -76872,32 +82343,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -76907,28 +82378,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76956,89 +82428,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77052,36 +82539,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -77091,124 +82580,143 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -77221,72 +82729,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -77295,12 +82811,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -77308,36 +82824,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -77346,12 +82869,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -77359,63 +82882,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77427,17 +82954,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -77451,20 +82978,23 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; @@ -77474,17 +83004,26 @@ export interface components { original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -77498,7 +83037,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -77506,9 +83045,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -77519,49 +83062,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77584,120 +83131,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -77708,48 +83263,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77790,32 +83356,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -77825,28 +83391,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -77874,37 +83441,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -77925,55 +83500,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77987,11 +83569,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -78014,26 +83598,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78048,60 +83632,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -78136,32 +83728,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -78171,28 +83763,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -78220,37 +83813,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -78264,55 +83865,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78326,11 +83934,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -78353,26 +83963,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78387,168 +83997,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -78561,74 +84198,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78637,12 +84283,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78650,36 +84296,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78688,12 +84341,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78701,69 +84354,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78785,120 +84442,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -78909,48 +84574,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78961,6 +84637,7 @@ export interface components { merge_method: "merge" | "squash" | "rebase"; } | null; base: { + /** @nullable */ label: string | null; ref: string; /** @@ -78991,32 +84668,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79026,28 +84703,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79075,37 +84753,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -79126,55 +84812,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79188,11 +84881,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -79215,26 +84910,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79249,68 +84944,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -79337,32 +85042,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79372,28 +85077,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79421,37 +85127,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -79472,55 +85186,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79534,11 +85255,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -79561,26 +85284,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79595,168 +85318,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -79769,74 +85519,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79845,12 +85604,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79858,36 +85617,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79896,12 +85662,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79909,69 +85675,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79993,120 +85763,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -80117,48 +85895,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80199,32 +85988,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -80234,28 +86023,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -80283,37 +86073,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -80334,55 +86132,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80396,11 +86201,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -80423,26 +86230,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80457,68 +86264,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -80545,32 +86362,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -80580,28 +86397,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -80629,37 +86447,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -80673,55 +86499,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80735,11 +86568,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -80762,26 +86597,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80796,168 +86631,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -80970,74 +86832,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81046,12 +86917,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81059,36 +86930,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81097,12 +86975,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81110,69 +86988,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81193,120 +87075,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -81317,48 +87207,56 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; /** @description Title for the merge commit message. */ commit_title: string; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81399,32 +87297,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -81434,28 +87332,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -81483,37 +87382,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -81534,55 +87441,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81596,11 +87510,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -81623,26 +87539,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -81657,60 +87573,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -81719,6 +87643,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -81745,32 +87670,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -81780,28 +87705,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -81829,37 +87755,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -81880,55 +87814,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81942,11 +87883,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -81969,26 +87912,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -82003,168 +87946,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -82177,74 +88147,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82253,12 +88232,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82266,36 +88245,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82304,12 +88290,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82317,69 +88303,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82403,9 +88393,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82416,9 +88409,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82434,14 +88430,14 @@ export interface components { /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; }[]; @@ -82454,7 +88450,10 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ forced: boolean; - /** Commit */ + /** + * Commit + * @nullable + */ head_commit: { /** @description An array of files added in the commit. */ added?: string[]; @@ -82463,9 +88462,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82476,9 +88478,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82494,14 +88499,14 @@ export interface components { /** @description An array of files removed in the commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; } | null; @@ -82512,9 +88517,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ pusher: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; /** @description The git author's name. */ name: string; @@ -82550,32 +88558,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -82589,28 +88597,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -82638,89 +88647,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82734,36 +88758,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -82781,7 +88807,9 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { + /** @nullable */ created_at: string | null; + /** @nullable */ description: string | null; ecosystem: string; html_url: string; @@ -82810,6 +88838,7 @@ export interface components { user_view_type?: string; }; package_type: string; + /** @nullable */ package_version: { author?: { avatar_url: string; @@ -82835,7 +88864,9 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { + /** @nullable */ labels: Record | null; + /** @nullable */ manifest: Record | null; tag: { digest: string; @@ -82856,22 +88887,27 @@ export interface components { [key: string]: unknown; }[]; name: string; + /** @nullable */ npm_metadata?: { name: string; version: string; npm_user: string; + /** @nullable */ author: (string | Record) | null; + /** @nullable */ bugs: (string | Record) | null; dependencies: Record; dev_dependencies: Record; peer_dependencies: Record; optional_dependencies: Record; description: string; + /** @nullable */ dist: (string | Record) | null; git_head: string; homepage: string; license: string; main: string; + /** @nullable */ repository: (string | Record) | null; scripts: Record; id: string; @@ -82885,6 +88921,7 @@ export interface components { files: string[]; bin: Record; man: Record; + /** @nullable */ directories: (string | Record) | null; os: string[]; cpu: string[]; @@ -82895,7 +88932,9 @@ export interface components { published_via_actions: boolean; deleted_by_id: number; } | null; + /** @nullable */ nuget_metadata?: { + /** @nullable */ id: (string | Record | number) | null; name: string; value: boolean | string | number | { @@ -82910,11 +88949,15 @@ export interface components { created_at: string; download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; + /** @nullable */ sha256: string | null; size: number; + /** @nullable */ state: string | null; updated_at: string; }[]; @@ -82946,6 +88989,7 @@ export interface components { draft: boolean; html_url: string; id: number; + /** @nullable */ name: string | null; prerelease: boolean; published_at: string; @@ -82961,6 +89005,7 @@ export interface components { updated_at?: string; version: string; } | null; + /** @nullable */ registry: { about_url: string; name: string; @@ -82968,6 +89013,7 @@ export interface components { url: string; vendor: string; } | null; + /** @nullable */ updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; @@ -82981,6 +89027,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { created_at: string; + /** @nullable */ description: unknown; ecosystem: string; html_url: string; @@ -83052,8 +89099,10 @@ export interface components { created_at: string; download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; sha256: string; size: number; @@ -83103,6 +89152,7 @@ export interface components { updated_at: string; version: string; }; + /** @nullable */ registry: Record | null; updated_at: string; }; @@ -83169,13 +89219,14 @@ export interface components { */ release: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -83186,98 +89237,111 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @@ -83285,7 +89349,10 @@ export interface components { * @enum {boolean} */ prerelease: true; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -83298,20 +89365,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -83407,7 +89480,10 @@ export interface components { /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ action: string; branch: string; - /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + /** + * @nullable + * @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + */ client_payload: { [key: string]: unknown; } | null; @@ -83426,12 +89502,15 @@ export interface components { from: string; }; description: { + /** @nullable */ from: string | null; }; homepage: { + /** @nullable */ from: string | null; }; topics: { + /** @nullable */ from: string[] | null; }; }; @@ -83577,65 +89656,70 @@ export interface components { from: { /** Organization */ organization: { - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; - /** Format: uri */ + /** @format uri */ issues_url: string; login: string; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ public_members_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -83681,52 +89765,60 @@ export interface components { affected_package_name: string; affected_range: string; created_at: string; + /** @nullable */ dismiss_comment?: string | null; dismiss_reason: string; dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ dismisser: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -83768,48 +89860,55 @@ export interface components { created_at: string; dismiss_reason?: string; dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -83912,20 +90011,27 @@ export interface components { */ source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at: string; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at: string; - /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + /** + * @nullable + * @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates + */ secret_types?: string[] | null; - /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + /** + * @nullable + * @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated + */ custom_pattern_name?: string | null; /** + * @nullable * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated * @enum {string|null} */ @@ -83970,6 +90076,7 @@ export interface components { security_advisory: { cvss: { score: number; + /** @nullable */ vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -83985,13 +90092,14 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; summary: string; updated_at: string; vulnerabilities: { + /** @nullable */ first_patched_version: { identifier: string; } | null; @@ -84104,7 +90212,10 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ starred_at: string | null; }; /** star deleted event */ @@ -84116,68 +90227,85 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ starred_at: unknown; }; /** status event */ "webhook-status": { - /** Format: uri */ + /** + * @nullable + * @format uri + */ avatar_url?: string | null; /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */ branches: { commit: { + /** @nullable */ sha: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; name: string; protected: boolean; }[]; commit: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url: string; deleted: boolean; + /** @nullable */ email: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; - /** Format: uri-template */ + /** @format uri-template */ following_url: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url: string; gravatar_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; login: string; name: string; node_id: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; site_admin: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; /** @enum {string} */ type: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url: string; } | null; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -84189,9 +90317,12 @@ export interface components { }; comment_count: number; committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -84204,74 +90335,84 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification: { + /** @nullable */ payload: string | null; /** @enum {string} */ reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; + /** @nullable */ signature: string | null; verified: boolean; + /** @nullable */ verified_at?: string | null; }; }; - /** User */ + /** + * User + * @nullable + */ committer: { - /** Format: uri */ + /** @format uri */ avatar_url: string; deleted: boolean; + /** @nullable */ email: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; - /** Format: uri-template */ + /** @format uri-template */ following_url: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url: string; gravatar_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; login: string; name: string; node_id: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; site_admin: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; /** @enum {string} */ type: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; node_id: string; parents: { - /** Format: uri */ + /** @format uri */ html_url: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }[]; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; context: string; created_at: string; - /** @description The optional human-readable description added to the status. */ + /** + * @nullable + * @description The optional human-readable description added to the status. + */ description: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ @@ -84288,7 +90429,10 @@ export interface components { * @enum {string} */ state: "pending" | "success" | "failure" | "error"; - /** @description The optional link added to the status. */ + /** + * @nullable + * @description The optional link added to the status. + */ target_url: string | null; updated_at: string; }; @@ -84400,32 +90544,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84439,28 +90583,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84483,89 +90628,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84579,36 +90739,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -84653,32 +90815,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84692,28 +90854,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84736,89 +90899,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84832,36 +91010,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -84906,32 +91086,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84945,28 +91125,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84989,89 +91170,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85085,36 +91281,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85190,32 +91388,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85229,28 +91427,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -85273,89 +91472,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85369,36 +91583,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85443,32 +91659,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85482,28 +91698,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -85526,89 +91743,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85622,36 +91854,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85674,6 +91908,7 @@ export interface components { /** workflow_dispatch event */ "webhook-workflow-dispatch": { enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @nullable */ inputs: { [key: string]: unknown; } | null; @@ -85694,15 +91929,19 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85711,15 +91950,27 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_name: string | null; started_at: string; /** @@ -85727,21 +91978,32 @@ export interface components { * @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "queued"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; @@ -85759,15 +92021,25 @@ export interface components { run_attempt?: number; run_id?: number; run_url?: string; + /** @nullable */ runner_group_id?: number | null; + /** @nullable */ runner_group_name?: string | null; + /** @nullable */ runner_id?: number | null; + /** @nullable */ runner_name?: string | null; started_at?: string; status?: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name?: string | null; steps?: (Record | null)[]; url?: string; @@ -85784,15 +92056,19 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | null | "cancelled" | "neutral"; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85801,15 +92077,27 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_name: string | null; started_at: string; /** @@ -85817,25 +92105,38 @@ export interface components { * @enum {string} */ status: "queued" | "in_progress" | "completed"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | null | "cancelled"; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; + /** @nullable */ completed_at?: string | null; + /** @nullable */ conclusion?: string | null; /** @description The time that the job created. */ created_at?: string; @@ -85848,22 +92149,35 @@ export interface components { run_attempt?: number; run_id?: number; run_url?: string; + /** @nullable */ runner_group_id?: number | null; + /** @nullable */ runner_group_name?: string | null; + /** @nullable */ runner_id?: number | null; + /** @nullable */ runner_name?: string | null; started_at?: string; /** @enum {string} */ status: "in_progress" | "completed" | "queued"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name?: string | null; steps: { + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "pending" | "queued"; @@ -85882,14 +92196,16 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -85897,31 +92213,46 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; + /** @nullable */ runner_group_id: number | null; + /** @nullable */ runner_group_name: string | null; + /** @nullable */ runner_id: number | null; + /** @nullable */ runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -85936,14 +92267,16 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -85951,31 +92284,46 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; + /** @nullable */ runner_group_id: number | null; + /** @nullable */ runner_group_name: string | null; + /** @nullable */ runner_id: number | null; + /** @nullable */ runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; /** @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -85992,57 +92340,65 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86051,9 +92407,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86064,9 +92423,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86079,143 +92441,152 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -86224,7 +92595,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -86235,16 +92606,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -86252,183 +92624,192 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. @@ -86449,56 +92830,64 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86507,9 +92896,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86520,9 +92912,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86535,142 +92930,154 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** @description The name of the repository. */ + /** + * @nullable + * @description The name of the repository. + */ name: string | null; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -86679,7 +93086,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -86690,16 +93097,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -86707,181 +93115,190 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; }; }; @@ -86897,57 +93314,65 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86956,9 +93381,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86969,9 +93397,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86984,143 +93415,152 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: { base: { @@ -87129,7 +93569,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -87140,16 +93580,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -87157,183 +93598,192 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; display_title: string; }; @@ -87450,6 +93900,7 @@ export interface components { block: { reason: string; created_at: string; + /** @nullable */ html_url: string | null; }; message: string; @@ -88237,6 +94688,7 @@ export interface operations { "application/json": components["schemas"]["integration"] & ({ client_id: string; client_secret: string; + /** @nullable */ webhook_secret: string | null; pem: string; } & { @@ -89824,7 +96276,10 @@ export interface operations { [key: string]: { /** @description The new content of the file. */ content: string; - /** @description The new filename for the file. */ + /** + * @nullable + * @description The new filename for the file. + */ filename: string | null; } | null; }; @@ -90760,8 +97215,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at: string; /** @description Whether the notification has been read. */ @@ -91359,7 +97814,10 @@ export interface operations { * @enum {string} */ source: "github" | "partner" | "custom"; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ version: string | null; }; /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ @@ -91586,7 +98044,10 @@ export interface operations { maximum_runners: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip: boolean; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ image_version: string | null; }; }; @@ -92076,7 +98537,10 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; - /** @description The identifier of a hosted compute network configuration. */ + /** + * @nullable + * @description The identifier of a hosted compute network configuration. + */ network_configuration_id?: string | null; }; }; @@ -92742,7 +99206,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -94183,7 +100650,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; @@ -94877,7 +101347,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -97426,7 +103899,10 @@ export interface operations { * @enum {string} */ action: "approve" | "deny"; - /** @description Reason for approving or denying the requests. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the requests. Max 1024 characters. + */ reason?: string | null; }; }; @@ -97459,7 +103935,10 @@ export interface operations { * @enum {string} */ action: "approve" | "deny"; - /** @description Reason for approving or denying the request. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the request. Max 1024 characters. + */ reason?: string | null; }; }; @@ -97701,9 +104180,15 @@ export interface operations { * @enum {string} */ registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ key_id: string; @@ -97838,9 +104323,15 @@ export interface operations { * @enum {string} */ registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ username: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ key_id: string; @@ -99362,7 +105853,10 @@ export interface operations { * @enum {string} */ permission: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ parent_team_id: number | null; }; }; @@ -100547,6 +107041,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100592,6 +107087,7 @@ export interface operations { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom + * @pattern ^(?:top|bottom|after:\d+)$ */ position: string; /** @@ -100787,6 +107283,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100862,6 +107359,7 @@ export interface operations { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last + * @pattern ^(?:first|last|after:\d+)$ */ position: string; }; @@ -100966,6 +107464,7 @@ export interface operations { */ name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -101347,6 +107846,7 @@ export interface operations { */ visibility: "public" | "private"; /** + * @nullable * @description Specify which security and analysis features to enable or disable for the repository. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -103265,7 +109765,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -104224,7 +110727,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Require status checks to pass before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require status checks to pass before merging. Set to `null` to disable. + */ required_status_checks: { /** @description Require branches to be up to date before merging. */ strict: boolean; @@ -104241,9 +110747,15 @@ export interface operations { app_id?: number; }[]; } | null; - /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ + /** + * @nullable + * @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ enforce_admins: boolean | null; - /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ required_pull_request_reviews: { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions: { @@ -104275,7 +110787,10 @@ export interface operations { apps: string[]; }; } | null; - /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ + /** + * @nullable + * @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ restrictions: { /** @description The list of user `login`s with push access */ users: string[]; @@ -104286,7 +110801,10 @@ export interface operations { } | null; /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ required_linear_history?: boolean; - /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + /** + * @nullable + * @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ allow_force_pushes?: boolean | null; /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ allow_deletions?: boolean; @@ -105382,8 +111900,8 @@ export interface operations { */ status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** - * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @@ -105393,8 +111911,8 @@ export interface operations { */ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -105524,8 +112042,8 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ external_id: string; /** - * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at: string; /** @@ -105540,8 +112058,8 @@ export interface operations { */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -106560,15 +113078,15 @@ export interface operations { ref: components["schemas"]["code-scanning-ref-full"]; sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** - * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ + * @format uri */ checkout_uri?: string; /** - * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ @@ -106927,6 +113445,7 @@ export interface operations { billable_owner: components["schemas"]["simple-user"]; defaults: { location: string; + /** @nullable */ devcontainer_path: string | null; }; }; @@ -107075,7 +113594,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -108470,7 +114992,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -108697,6 +115222,7 @@ export interface operations { */ environment?: string; /** + * @nullable * @description Short description of the deployment. * @default */ @@ -109046,7 +115572,10 @@ export interface operations { "application/json": { wait_timer: components["schemas"]["wait-timer"]; prevent_self_review: components["schemas"]["prevent-self-review"]; - /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ + /** + * @nullable + * @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + */ reviewers: { type: components["schemas"]["deployment-reviewer-type"]; /** @@ -109552,7 +116081,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -109982,8 +116514,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -109994,8 +116526,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date: string; }; @@ -110259,8 +116791,8 @@ export interface operations { /** @description The email of the author of the tag */ email: string; /** - * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -110341,6 +116873,7 @@ export interface operations { */ type: "blob" | "tree" | "commit"; /** + * @nullable * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. @@ -111364,14 +117897,20 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ + /** + * @nullable + * @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ + */ assignee?: string | null; + /** @nullable */ milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ labels?: (string | { id: number; name: string; + /** @nullable */ description: string | null; + /** @nullable */ color: string | null; })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ @@ -111745,11 +118284,20 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The title of the issue. */ + /** + * @nullable + * @description The title of the issue. + */ title: (string | number) | null; - /** @description The contents of the issue. */ + /** + * @nullable + * @description The contents of the issue. + */ body: string | null; - /** @description Username to assign to this issue. **This field is closing down.** */ + /** + * @nullable + * @description Username to assign to this issue. **This field is closing down.** + */ assignee: string | null; /** * @description The open or closed state of the issue. @@ -111757,17 +118305,21 @@ export interface operations { */ state: "open" | "closed"; /** + * @nullable * @description The reason for the state change. Ignored unless `state` is changed. * @example not_planned * @enum {string|null} */ state_reason: "completed" | "not_planned" | "reopened" | null; + /** @nullable */ milestone: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ labels: (string | { id: number; name: string; + /** @nullable */ description: string | null; + /** @nullable */ color: string | null; })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ @@ -113073,8 +119625,8 @@ export interface operations { /** @description A description of the milestone. */ description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on?: string; }; @@ -113178,8 +119730,8 @@ export interface operations { /** @description A description of the milestone. */ description: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on: string; }; @@ -113285,8 +119837,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at: string; }; @@ -113355,7 +119907,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ + /** + * @nullable + * @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." + */ cname: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced: boolean; @@ -113981,9 +120536,9 @@ export interface operations { /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ head: string; /** - * Format: repo.nwo * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. * @example octo-org/octo-repo + * @format repo.nwo */ head_repo?: string; /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ @@ -113995,9 +120550,9 @@ export interface operations { /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ draft?: boolean; /** - * Format: int64 * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. * @example 1 + * @format int64 */ issue?: number; }; @@ -116844,12 +123399,16 @@ export interface operations { */ state: "error" | "failure" | "pending" | "success"; /** + * @nullable * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; - /** @description A short description of the status. */ + /** + * @nullable + * @description A short description of the status. + */ description?: string | null; /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. @@ -117915,7 +124474,10 @@ export interface operations { * @enum {string} */ permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ parent_team_id?: number | null; }; }; @@ -118999,6 +125561,7 @@ export interface operations { */ blog: string; /** + * @nullable * @description The new Twitter username of the user. * @example therealomarj */ @@ -119358,7 +125921,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -120489,7 +127055,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. */ + /** + * @description The public SSH key to add to your GitHub account. + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) + */ key: string; }; }; @@ -121228,6 +127797,7 @@ export interface operations { */ name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -121720,7 +128290,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** + * @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com + */ key: string; }; }; diff --git a/packages/openapi-typescript/examples/github-api-root-types.ts b/packages/openapi-typescript/examples/github-api-root-types.ts index 18af3fe0a..96393dd98 100644 --- a/packages/openapi-typescript/examples/github-api-root-types.ts +++ b/packages/openapi-typescript/examples/github-api-root-types.ts @@ -18417,74 +18417,74 @@ export type webhooks = Record; export interface components { schemas: { root: { - /** Format: uri-template */ + /** @format uri-template */ current_user_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_authorizations_html_url: string; - /** Format: uri-template */ + /** @format uri-template */ authorizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ code_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ commit_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ emails_url: string; - /** Format: uri-template */ + /** @format uri-template */ emojis_url: string; - /** Format: uri-template */ + /** @format uri-template */ events_url: string; - /** Format: uri-template */ + /** @format uri-template */ feeds_url: string; - /** Format: uri-template */ + /** @format uri-template */ followers_url: string; - /** Format: uri-template */ + /** @format uri-template */ following_url: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url: string; /** - * Format: uri-template * @deprecated + * @format uri-template */ hub_url?: string; - /** Format: uri-template */ + /** @format uri-template */ issue_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ label_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ public_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ rate_limit_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ topic_search_url?: string; - /** Format: uri-template */ + /** @format uri-template */ user_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_organizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_search_url: string; }; /** @@ -18494,34 +18494,67 @@ export interface components { "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ vulnerability: { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range: string | null; - /** @description The package version that resolves the vulnerability. */ + /** + * @nullable + * @description The package version that resolves the vulnerability. + */ first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ + /** + * @nullable + * @description The functions in the package that are affected by the vulnerability. + */ readonly vulnerable_functions: string[] | null; }; + /** @nullable */ "cvss-severities": { + /** @nullable */ cvss_v3?: { - /** @description The CVSS 3 vector string. */ + /** + * @nullable + * @description The CVSS 3 vector string. + */ vector_string: string | null; - /** @description The CVSS 3 score. */ + /** + * @nullable + * @description The CVSS 3 score. + */ readonly score: number | null; } | null; + /** @nullable */ cvss_v4?: { - /** @description The CVSS 4 vector string. */ + /** + * @nullable + * @description The CVSS 4 vector string. + */ vector_string: string | null; - /** @description The CVSS 4 score. */ + /** + * @nullable + * @description The CVSS 4 score. + */ readonly score: number | null; } | null; } | null; - /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + /** + * @nullable + * @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). + */ "security-advisory-epss": { percentage?: number; percentile?: number; @@ -18531,37 +18564,42 @@ export interface components { * @description A GitHub user. */ "simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -18571,25 +18609,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -18609,23 +18647,30 @@ export interface components { "global-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id: string | null; /** @description The API URL for the advisory. */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The API URL for the repository advisory. + * @format uri */ readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ description: string | null; /** * @description The type of advisory. @@ -18638,10 +18683,12 @@ export interface components { */ severity: "critical" | "high" | "medium" | "low" | "unknown"; /** - * Format: uri + * @nullable * @description The URL of the advisory's source code. + * @format uri */ source_code_location: string | null; + /** @nullable */ readonly identifiers: { /** * @description The type of identifier. @@ -18651,50 +18698,68 @@ export interface components { /** @description The identifier value. */ value: string; }[] | null; + /** @nullable */ references: string[] | null; /** - * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + * @format date-time */ readonly github_reviewed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. * This field is only populated when the advisory is imported from the National Vulnerability Database. + * @format date-time */ readonly nvd_published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; - /** @description The products and respective version ranges affected by the advisory. */ + /** + * @nullable + * @description The products and respective version ranges affected by the advisory. + */ vulnerabilities: components["schemas"]["vulnerability"][] | null; + /** @nullable */ cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; epss?: components["schemas"]["security-advisory-epss"]; + /** @nullable */ cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description The users who contributed to the advisory. */ + /** + * @nullable + * @description The users who contributed to the advisory. + */ readonly credits: { user: components["schemas"]["simple-user"]; type: components["schemas"]["security-advisory-credit-types"]; @@ -18724,16 +18789,20 @@ export interface components { * @description An enterprise on GitHub. */ enterprise: { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -18754,20 +18823,23 @@ export interface components { */ slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ integration: { @@ -18791,26 +18863,29 @@ export interface components { * @example Probot Owners */ name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ updated_at: string; /** @@ -18844,15 +18919,18 @@ export interface components { installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; } | null; /** - * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook + * @format uri */ "webhook-config-url": string; /** @@ -18892,9 +18970,9 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z + * @format date-time */ delivered_at: string; /** @@ -18923,24 +19001,28 @@ export interface components { */ event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ throttled_at?: string | null; }; @@ -18949,10 +19031,14 @@ export interface components { * @description Scim Error */ "scim-error": { + /** @nullable */ message?: string | null; + /** @nullable */ documentation_url?: string | null; + /** @nullable */ detail?: string | null; status?: number; + /** @nullable */ scimType?: string | null; schemas?: string[]; }; @@ -18988,9 +19074,9 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z + * @format date-time */ delivered_at: string; /** @@ -19019,24 +19105,28 @@ export interface components { */ event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ throttled_at?: string | null; /** @@ -19045,21 +19135,33 @@ export interface components { */ url?: string; request: { - /** @description The request headers sent with the webhook delivery. */ + /** + * @nullable + * @description The request headers sent with the webhook delivery. + */ headers: { [key: string]: unknown; } | null; - /** @description The webhook payload. */ + /** + * @nullable + * @description The webhook payload. + */ payload: { [key: string]: unknown; } | null; }; response: { - /** @description The response headers received when the delivery was made. */ + /** + * @nullable + * @description The response headers received when the delivery was made. + */ headers: { [key: string]: unknown; } | null; - /** @description The response payload received. */ + /** + * @nullable + * @description The response payload received. + */ payload: string | null; }; }; @@ -19078,8 +19180,8 @@ export interface components { account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; requester: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; }; @@ -19337,40 +19439,46 @@ export interface components { }; /** * Simple User + * @nullable * @description A GitHub user. */ "nullable-simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -19380,25 +19488,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -19419,6 +19527,7 @@ export interface components { * @example 1 */ id: number; + /** @nullable */ account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -19426,18 +19535,18 @@ export interface components { */ repository_selection: "all" | "selected"; /** - * Format: uri * @example https://api.github.com/app/installations/1/access_tokens + * @format uri */ access_tokens_url: string; /** - * Format: uri * @example https://api.github.com/installation/repositories + * @format uri */ repositories_url: string; /** - * Format: uri * @example https://github.com/organizations/github/settings/installations/1 + * @format uri */ html_url: string; /** @example 1 */ @@ -19448,11 +19557,14 @@ export interface components { target_type: string; permissions: components["schemas"]["app-permissions"]; events: string[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -19466,13 +19578,20 @@ export interface components { /** @example github-actions */ app_slug: string; suspended_by: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at: string | null; - /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ + /** + * @nullable + * @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" + */ contact_email?: string | null; }; /** * License Simple + * @nullable * @description License Simple */ "nullable-license-simple": { @@ -19481,15 +19600,19 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; } | null; /** @@ -19498,9 +19621,9 @@ export interface components { */ repository: { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -19528,16 +19651,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -19559,28 +19685,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -19602,13 +19728,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -19622,30 +19748,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -19653,25 +19779,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -19743,18 +19872,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -19872,7 +20004,10 @@ export interface components { */ single_file_paths?: string[]; }; - /** Scoped Installation */ + /** + * Scoped Installation + * @nullable + */ "nullable-scoped-installation": { permissions: components["schemas"]["app-permissions"]; /** @@ -19880,7 +20015,10 @@ export interface components { * @enum {string} */ repository_selection: "all" | "selected"; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -19892,8 +20030,8 @@ export interface components { */ single_file_paths?: string[]; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repositories_url: string; account: components["schemas"]["simple-user"]; @@ -19903,32 +20041,45 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { - /** Format: int64 */ + /** @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ url: string; - /** @description A list of scopes that this authorization is in. */ + /** + * @nullable + * @description A list of scopes that this authorization is in. + */ scopes: string[] | null; token: string; + /** @nullable */ token_last_eight: string | null; + /** @nullable */ hashed_token: string | null; app: { client_id: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; + /** @nullable */ note: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ note_url: string | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; + /** @nullable */ fingerprint: string | null; user?: components["schemas"]["nullable-simple-user"]; installation?: components["schemas"]["nullable-scoped-installation"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; }; /** @@ -19947,9 +20098,9 @@ export interface components { */ full_name: string; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; /** @@ -19977,11 +20128,14 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://github.com/github + * @format uri */ html_url: string; - /** @example Github - Code thigns happen here */ + /** + * @nullable + * @example Github - Code thigns happen here + */ name: string | null; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; @@ -20065,11 +20219,13 @@ export interface components { */ feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ max_teams: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20100,9 +20256,10 @@ export interface components { */ language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ deadline: string | null; starter_code_repository: components["schemas"]["simple-classroom-repository"]; @@ -20118,13 +20275,13 @@ export interface components { /** @example octocat */ login: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; }; @@ -20206,11 +20363,13 @@ export interface components { */ feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ max_teams?: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20241,9 +20400,10 @@ export interface components { */ language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ deadline: string | null; classroom: components["schemas"]["simple-classroom"]; @@ -20320,8 +20480,8 @@ export interface components { /** @example Contributor Covenant */ name: string; /** - * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant + * @format uri */ url: string; /** @@ -20372,7 +20532,10 @@ export interface components { * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). */ body?: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; }; /** @description A code security configuration */ @@ -20423,14 +20586,21 @@ export interface components { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ code_scanning_default_setup_options?: { /** + * @nullable * @description Whether to use labeled runners or standard GitHub runners. * @enum {string|null} */ runner_type?: "standard" | "labeled" | "not_set" | null; - /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning when runner_type is 'labeled'. + */ runner_label?: string | null; } | null; /** @@ -20482,28 +20652,34 @@ export interface components { */ enforcement?: "enforced" | "unenforced"; /** - * Format: uri * @description The URL of the configuration + * @format uri */ url?: string; /** - * Format: uri * @description The URL of the configuration + * @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ "code-scanning-default-setup-options": { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ runner_type?: "standard" | "labeled" | "not_set"; - /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. + */ runner_label?: string | null; } | null; /** @description A list of default code security configurations */ @@ -20521,9 +20697,9 @@ export interface components { */ "simple-repository": { /** - * Format: int64 * @description A unique identifier of the repository. * @example 1296269 + * @format int64 */ id: number; /** @@ -20545,12 +20721,13 @@ export interface components { /** @description Whether the repository is private. */ private: boolean; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; /** + * @nullable * @description The repository description. * @example This your first repo! */ @@ -20558,9 +20735,9 @@ export interface components { /** @description Whether the repository is a fork. */ fork: boolean; /** - * Format: uri * @description The URL to get more information about the repository from the GitHub API. * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @@ -20609,33 +20786,33 @@ export interface components { */ contents_url: string; /** - * Format: uri * @description A template for the API URL to list the contributors to the repository. * @example https://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @description The API URL to list the deployments of the repository. * @example https://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @description The API URL to list the downloads on the repository. * @example https://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @description The API URL to list the events of the repository. * @example https://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @description The API URL to list the forks of the repository. * @example https://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @@ -20679,15 +20856,15 @@ export interface components { */ labels_url: string; /** - * Format: uri * @description The API URL to get information about the languages of the repository. * @example https://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @description The API URL to merge branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @@ -20711,9 +20888,9 @@ export interface components { */ releases_url: string; /** - * Format: uri * @description The API URL to list the stargazers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @@ -20722,27 +20899,27 @@ export interface components { */ statuses_url: string; /** - * Format: uri * @description The API URL to list the subscribers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @description The API URL to subscribe to notifications for this repository. * @example https://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @description The API URL to get information about tags on the repository. * @example https://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @description The API URL to list the teams on the repository. * @example https://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @@ -20751,9 +20928,9 @@ export interface components { */ trees_url: string; /** - * Format: uri * @description The API URL to list the hooks on the repository. * @example https://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; }; @@ -20785,7 +20962,10 @@ export interface components { readonly severity: "low" | "medium" | "high" | "critical"; /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ + /** + * @nullable + * @description Details pertaining to the package version that patches this vulnerability. + */ readonly first_patched_version: { /** @description The package version that patches this vulnerability. */ readonly identifier: string; @@ -20795,7 +20975,10 @@ export interface components { "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ + /** + * @nullable + * @description The unique CVE ID assigned to the advisory. + */ readonly cve_id: string | null; /** @description A short, plain text summary of the advisory. */ readonly summary: string; @@ -20812,7 +20995,10 @@ export interface components { readonly cvss: { /** @description The overall CVSS score of the advisory. */ readonly score: number; - /** @description The full CVSS vector string for the advisory. */ + /** + * @nullable + * @description The full CVSS vector string for the advisory. + */ readonly vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -20837,60 +21023,64 @@ export interface components { /** @description Links to additional advisory information. */ readonly references: { /** - * Format: uri * @description The URL of the reference. + * @format uri */ readonly url: string; }[]; /** - * Format: date-time * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly withdrawn_at: string | null; }; /** - * Format: uri * @description The REST API URL of the alert resource. + * @format uri */ "alert-url": string; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ "alert-html-url": string; /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-created-at": string; /** - * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-updated-at": string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-dismissed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-fixed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ @@ -20907,6 +21097,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -20921,19 +21112,24 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time + * @nullable * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "nullable-alert-updated-at": string | null; /** @@ -20942,6 +21138,7 @@ export interface components { */ "secret-scanning-alert-state": "open" | "resolved"; /** + * @nullable * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. * @enum {string|null} */ @@ -20953,15 +21150,16 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; @@ -20975,34 +21173,54 @@ export interface components { /** @description The secret that was detected. */ secret?: string; repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ + /** + * @nullable + * @description The comment that was optionally added when this alert was closed + */ resolution_comment?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ validity?: "active" | "inactive" | "unknown"; - /** @description Whether the secret was publicly leaked. */ + /** + * @nullable + * @description Whether the secret was publicly leaked. + */ publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. + */ multi_repo?: boolean | null; }; /** @@ -21013,30 +21231,32 @@ export interface components { id: number; login: string; display_login?: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ "nullable-milestone": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ labels_url: string; /** @example 1002604 */ @@ -21060,7 +21280,10 @@ export interface components { * @example v1.0 */ title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -21068,28 +21291,31 @@ export interface components { /** @example 8 */ closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ due_on: string | null; } | null; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ "nullable-integration": { @@ -21113,26 +21339,29 @@ export interface components { * @example Probot Owners */ name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ updated_at: string; /** @@ -21166,7 +21395,10 @@ export interface components { installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; @@ -21180,7 +21412,7 @@ export interface components { "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** Reaction Rollup */ "reaction-rollup": { - /** Format: uri */ + /** @format uri */ url: string; total_count: number; "+1": number; @@ -21203,23 +21435,23 @@ export interface components { * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ issue: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -21232,6 +21464,7 @@ export interface components { */ state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -21243,6 +21476,7 @@ export interface components { */ title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -21256,45 +21490,67 @@ export interface components { * ] */ labels: (string | { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ url?: string; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; default?: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; comments: number; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; draft?: boolean; closed_by?: components["schemas"]["nullable-simple-user"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21308,16 +21564,16 @@ export interface components { */ "issue-comment": { /** - * Format: int64 * @description Unique identifier of the issue comment * @example 42 + * @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ url: string; /** @@ -21327,20 +21583,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21352,12 +21608,13 @@ export interface components { */ event: { id: string; + /** @nullable */ type: string | null; actor: components["schemas"]["actor"]; repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; org?: components["schemas"]["actor"]; @@ -21368,6 +21625,7 @@ export interface components { pages?: { page_name?: string; title?: string; + /** @nullable */ summary?: string | null; action?: string; sha?: string; @@ -21375,7 +21633,10 @@ export interface components { }[]; }; public: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; }; /** @@ -21439,19 +21700,19 @@ export interface components { * @description Base Gist */ "base-gist": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -21468,15 +21729,16 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; + /** @nullable */ description: string | null; comments: number; comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; @@ -21489,7 +21751,7 @@ export interface components { */ "public-user": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; /** * @description discriminator enum property added by openapi-typescript @@ -21497,47 +21759,61 @@ export interface components { */ user_view_type: "public"; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; following_url: string; gists_url: string; starred_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; events_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; site_admin: boolean; + /** @nullable */ name: string | null; + /** @nullable */ company: string | null; + /** @nullable */ blog: string | null; + /** @nullable */ location: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ notification_email?: string | null; + /** @nullable */ hireable: boolean | null; + /** @nullable */ bio: string | null; + /** @nullable */ twitter_username?: string | null; public_repos: number; public_gists: number; followers: number; following: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; plan?: { collaborators: number; @@ -21563,14 +21839,14 @@ export interface components { "gist-history": { user?: components["schemas"]["nullable-simple-user"]; version?: string; - /** Format: date-time */ + /** @format date-time */ committed_at?: string; change_status?: { total?: number; additions?: number; deletions?: number; }; - /** Format: uri */ + /** @format uri */ url?: string; }; /** @@ -21578,37 +21854,44 @@ export interface components { * @description Gist Simple */ "gist-simple": { - /** @deprecated */ + /** + * @deprecated + * @nullable + */ forks?: { id?: string; - /** Format: uri */ + /** @format uri */ url?: string; user?: components["schemas"]["public-user"]; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }[] | null; - /** @deprecated */ + /** + * @deprecated + * @nullable + */ history?: components["schemas"]["gist-history"][] | null; /** * Gist + * @nullable * @description Gist */ fork_of?: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -21620,15 +21903,16 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; + /** @nullable */ description: string | null; comments: number; comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; @@ -21662,9 +21946,11 @@ export interface components { public?: boolean; created_at?: string; updated_at?: string; + /** @nullable */ description?: string | null; comments?: number; comments_enabled?: boolean; + /** @nullable */ user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -21680,8 +21966,8 @@ export interface components { /** @example MDExOkdpc3RDb21tZW50MQ== */ node_id: string; /** - * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + * @format uri */ url: string; /** @@ -21691,13 +21977,13 @@ export interface components { body: string; user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ updated_at: string; author_association: components["schemas"]["author-association"]; @@ -21708,8 +21994,8 @@ export interface components { */ "gist-commit": { /** - * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + * @format uri */ url: string; /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ @@ -21721,8 +22007,8 @@ export interface components { deletions?: number; }; /** - * Format: date-time * @example 2010-04-14T02:15:15Z + * @format date-time */ committed_at: string; }; @@ -21764,15 +22050,19 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; }; /** @@ -21784,18 +22074,22 @@ export interface components { key: string; /** @example MIT License */ name: string; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; /** - * Format: uri * @example http://choosealicense.com/licenses/mit/ + * @format uri */ html_url: string; /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ @@ -21857,13 +22151,13 @@ export interface components { */ "marketplace-listing-plan": { /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts + * @format uri */ accounts_url: string; /** @example 1313 */ @@ -21885,6 +22179,7 @@ export interface components { price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; /** @example true */ has_free_trial: boolean; + /** @nullable */ unit_name: string | null; /** @example published */ state: string; @@ -21906,20 +22201,26 @@ export interface components { id: number; login: string; organization_billing_email?: string; + /** @nullable */ email?: string | null; + /** @nullable */ marketplace_pending_change?: { is_installed?: boolean; effective_date?: string; + /** @nullable */ unit_count?: number | null; id?: number; plan?: components["schemas"]["marketplace-listing-plan"]; } | null; marketplace_purchase: { billing_cycle?: string; + /** @nullable */ next_billing_date?: string | null; is_installed?: boolean; + /** @nullable */ unit_count?: number | null; on_free_trial?: boolean; + /** @nullable */ free_trial_ends_on?: string | null; updated_at?: string; plan?: components["schemas"]["marketplace-listing-plan"]; @@ -22043,6 +22344,7 @@ export interface components { }; }; }; + /** @nullable */ "security-and-analysis": { advanced_security?: { /** @enum {string} */ @@ -22079,8 +22381,8 @@ export interface components { */ "minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -22092,16 +22394,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -22123,28 +22428,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -22165,13 +22470,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -22184,43 +22489,46 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ trees_url: string; clone_url?: string; + /** @nullable */ mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; svn_url?: string; + /** @nullable */ homepage?: string | null; + /** @nullable */ language?: string | null; forks_count?: number; stargazers_count?: number; @@ -22241,18 +22549,21 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at?: string | null; permissions?: { @@ -22269,6 +22580,7 @@ export interface components { subscribers_count?: number; network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ license?: { key?: string; name?: string; @@ -22303,6 +22615,7 @@ export interface components { reason: string; unread: boolean; updated_at: string; + /** @nullable */ last_read_at: string | null; url: string; /** @example https://api.github.com/notifications/threads/2/subscription */ @@ -22316,25 +22629,27 @@ export interface components { /** @example true */ subscribed: boolean; ignored: boolean; + /** @nullable */ reason: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-06T21:34:12Z + * @format date-time */ created_at: string | null; /** - * Format: uri * @example https://api.github.com/notifications/threads/1/subscription + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/notifications/threads/1 + * @format uri */ thread_url?: string; /** - * Format: uri * @example https://api.github.com/repos/1 + * @format uri */ repository_url?: string; }; @@ -22350,18 +22665,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22374,7 +22689,10 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; }; "billing-usage-report": { @@ -22415,18 +22733,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22439,25 +22757,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -22474,8 +22798,8 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** @example Organization */ @@ -22484,11 +22808,18 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; /** + * @nullable * @description The number of collaborators on private repositories. * * This field may be null if the number of private repositories is over 50,000. @@ -22496,8 +22827,9 @@ export interface components { */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -22507,10 +22839,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -22526,7 +22865,10 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; @@ -22596,18 +22938,22 @@ export interface components { */ secret_scanning_push_protection_custom_link_enabled?: boolean; /** + * @nullable * @description An optional URL string to display to contributors who are blocked from pushing a secret. * @example https://github.com/test-org/test-repo/blob/main/README.md */ secret_scanning_push_protection_custom_link?: string | null; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ archived_at: string | null; /** * @description Controls whether or not deploy keys may be added and used for repositories in the organization. @@ -22644,6 +22990,7 @@ export interface components { }; /** * GitHub-hosted runner image details. + * @nullable * @description Provides details of a hosted runner image */ "nullable-actions-hosted-runner-pool-image": { @@ -22767,9 +23114,10 @@ export interface components { /** @description The public IP ranges when public IP is enabled for the hosted runners. */ public_ips?: components["schemas"]["public-ip"][]; /** - * Format: date-time + * @nullable * @description The time at which the runner was last used, in ISO 8601 format. * @example 2022-10-09T23:39:01Z + * @format date-time */ last_active_on?: string | null; }; @@ -22981,9 +23329,9 @@ export interface components { */ token: string; /** - * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z + * @format date-time */ expires_at: string; /** @@ -22995,7 +23343,10 @@ export interface components { permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file?: string | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -23013,9 +23364,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -23023,8 +23374,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23068,15 +23419,15 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ updated_at: string; /** @@ -23085,14 +23436,17 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/variables/USERNAME/repositories + * @format uri */ selected_repositories_url?: string; }; /** @description The name of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-name": string; - /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + /** + * @nullable + * @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. + */ "code-scanning-analysis-tool-guid": string | null; /** * @description State of a code scanning alert. @@ -23105,33 +23459,43 @@ export interface components { */ "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; /** - * Format: uri * @description The REST API URL for fetching the list of instances for an alert. + * @format uri */ "alert-instances-url": string; /** + * @nullable * @description State of a code scanning alert. * @enum {string|null} */ "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** + * @nullable * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; - /** @description The dismissal comment associated with the dismissal of the alert. */ + /** + * @nullable + * @description The dismissal comment associated with the dismissal of the alert. + */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -23140,14 +23504,26 @@ export interface components { description?: string; /** @description A description of the rule used to detect the alert. */ full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; }; - /** @description The version of the tool used to generate the code scanning analysis. */ + /** + * @nullable + * @description The version of the tool used to generate the code scanning analysis. + */ "code-scanning-analysis-tool-version": string | null; "code-scanning-analysis-tool": { name?: components["schemas"]["code-scanning-analysis-tool-name"]; @@ -23174,6 +23550,7 @@ export interface components { end_column?: number; }; /** + * @nullable * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ @@ -23216,6 +23593,7 @@ export interface components { }; /** * Codespace machine + * @nullable * @description A description of the machine powering a codespace. */ "nullable-codespace-machine": { @@ -23250,6 +23628,7 @@ export interface components { */ cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -23262,8 +23641,8 @@ export interface components { */ codespace: { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -23272,11 +23651,13 @@ export interface components { */ name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -23286,29 +23667,31 @@ export interface components { repository: components["schemas"]["minimal-repository"]; machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ last_used_at: string; /** @@ -23318,8 +23701,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -23351,63 +23734,81 @@ export interface components { */ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ allowed_port_privacy_settings?: string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ retention_expires_at?: string | null; /** + * @nullable * @description The text to display to a user when a codespace has been stopped for a potentially actionable reason. * @example you've used 100% of your spending limit for Codespaces */ @@ -23424,13 +23825,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -23439,9 +23840,9 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23528,6 +23929,7 @@ export interface components { }; /** * Organization Simple + * @nullable * @description A GitHub organization. */ "nullable-organization-simple": { @@ -23538,18 +23940,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -23562,11 +23964,15 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; } | null; /** * Team Simple + * @nullable * @description Groups of organization members that gives permissions on specified repositories. */ "nullable-team-simple": { @@ -23578,9 +23984,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -23591,6 +23997,7 @@ export interface components { */ name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -23611,13 +24018,13 @@ export interface components { */ notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; /** @example justice-league */ @@ -23637,6 +24044,7 @@ export interface components { node_id: string; name: string; slug: string; + /** @nullable */ description: string | null; privacy?: string; notification_setting?: string; @@ -23648,15 +24056,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; @@ -23665,27 +24073,33 @@ export interface components { * @description Group of enterprise owners and/or members */ "enterprise-team": { - /** Format: int64 */ + /** @format int64 */ id: number; name: string; slug: string; - /** Format: uri */ + /** @format uri */ url: string; /** @example disabled | all */ sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + /** + * @nullable + * @example 62ab9291-fae2-468e-974b-7e45096d5021 + */ group_id?: string | null; - /** @example Justice League */ + /** + * @nullable + * @example Justice League + */ group_name?: string | null; /** - * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league + * @format uri */ html_url: string; members_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -23695,29 +24109,37 @@ export interface components { "copilot-seat-details": { assignee: components["schemas"]["simple-user"]; organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + /** + * @nullable + * @description The team through which the assignee is granted access to GitHub Copilot, if applicable. + */ assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** - * Format: date + * @nullable * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @format date */ pending_cancellation_date?: string | null; /** - * Format: date-time + * @nullable * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @format date-time */ last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + /** + * @nullable + * @description Last editor that was used by the user for a GitHub Copilot completion. + */ last_activity_editor?: string | null; /** - * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @format date-time */ created_at: string; /** - * Format: date-time * @deprecated * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @format date-time */ updated_at?: string; /** @@ -23726,7 +24148,10 @@ export interface components { */ plan_type?: "business" | "enterprise" | "unknown"; }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot editor code completions in the IDE. + */ "copilot-ide-code-completions": ({ /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ total_engaged_users?: number; @@ -23748,7 +24173,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date?: string | null; /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ total_engaged_users?: number; @@ -23774,7 +24202,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in the IDE. + */ "copilot-ide-chat": ({ /** @description Total number of users who prompted Copilot Chat in the IDE. */ total_engaged_users?: number; @@ -23789,7 +24220,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date?: string | null; /** @description The number of users who prompted Copilot Chat in the given editor and model. */ total_engaged_users?: number; @@ -23804,7 +24238,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in github.com + */ "copilot-dotcom-chat": ({ /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ total_engaged_users?: number; @@ -23814,7 +24251,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ + /** + * @nullable + * @description The training date for the custom model (if applicable). + */ custom_model_training_date?: string | null; /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ total_engaged_users?: number; @@ -23824,7 +24264,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot for pull requests. */ + /** + * @nullable + * @description Usage metrics for Copilot for pull requests. + */ "copilot-dotcom-pull-requests": ({ /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ total_engaged_users?: number; @@ -23840,7 +24283,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date?: string | null; /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ total_pr_summaries_created?: number; @@ -23857,8 +24303,8 @@ export interface components { */ "copilot-usage-metrics-day": { /** - * Format: date * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @format date */ date: string; /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ @@ -23878,8 +24324,8 @@ export interface components { */ "copilot-usage-metrics": { /** - * Format: date * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @format date */ day: string; /** @description The total number of Copilot code completion suggestions shown to users. */ @@ -23898,7 +24344,10 @@ export interface components { total_chat_turns?: number; /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ + /** + * @nullable + * @description Breakdown of Copilot code completions usage by language and editor + */ breakdown: ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ language?: string; @@ -23928,9 +24377,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -23938,8 +24387,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23961,12 +24410,13 @@ export interface components { }; /** * Minimal Repository + * @nullable * @description Minimal Repository */ "nullable-minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -23978,16 +24428,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -24009,28 +24462,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -24051,13 +24504,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -24070,43 +24523,46 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ trees_url: string; clone_url?: string; + /** @nullable */ mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; svn_url?: string; + /** @nullable */ homepage?: string | null; + /** @nullable */ language?: string | null; forks_count?: number; stargazers_count?: number; @@ -24127,18 +24583,21 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at?: string | null; permissions?: { @@ -24155,6 +24614,7 @@ export interface components { subscribers_count?: number; network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ license?: { key?: string; name?: string; @@ -24209,9 +24669,9 @@ export interface components { visibility: "private" | "public"; owner?: components["schemas"]["nullable-simple-user"]; repository?: components["schemas"]["nullable-minimal-repository"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24219,13 +24679,17 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { - /** Format: int64 */ + /** @format int64 */ id: number; + /** @nullable */ login: string | null; + /** @nullable */ email: string | null; role: string; created_at: string; + /** @nullable */ failed_at?: string | null; + /** @nullable */ failed_reason?: string | null; inviter: components["schemas"]["simple-user"]; team_count: number; @@ -24244,18 +24708,18 @@ export interface components { /** @example 1 */ id: number; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings + * @format uri */ ping_url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries + * @format uri */ deliveries_url?: string; /** @example web */ @@ -24280,13 +24744,13 @@ export interface components { secret?: string; }; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ created_at: string; type: string; @@ -24301,15 +24765,16 @@ export interface components { /** @description The API path's route template */ api_route?: string; /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count?: number; + /** @nullable */ last_rate_limited_timestamp?: string | null; last_request_timestamp?: string; }[]; @@ -24320,10 +24785,11 @@ export interface components { "api-insights-subject-stats": { subject_type?: string; subject_name?: string; - /** Format: int64 */ + /** @format int64 */ subject_id?: number; total_request_count?: number; rate_limited_request_count?: number; + /** @nullable */ last_rate_limited_timestamp?: string | null; last_request_timestamp?: string; }[]; @@ -24333,13 +24799,13 @@ export interface components { */ "api-insights-summary-stats": { /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count?: number; }; @@ -24349,9 +24815,9 @@ export interface components { */ "api-insights-time-stats": { timestamp?: string; - /** Format: int64 */ + /** @format int64 */ total_request_count?: number; - /** Format: int64 */ + /** @format int64 */ rate_limited_request_count?: number; }[]; /** @@ -24361,14 +24827,21 @@ export interface components { "api-insights-user-stats": { actor_type?: string; actor_name?: string; - /** Format: int64 */ + /** @format int64 */ actor_id?: number; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ integration_id?: number | null; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ oauth_application_id?: number | null; total_request_count?: number; rate_limited_request_count?: number; + /** @nullable */ last_rate_limited_timestamp?: string | null; last_request_timestamp?: string; }[]; @@ -24387,8 +24860,8 @@ export interface components { /** @example repository */ origin: string; /** - * Format: date-time * @example 2018-08-17T04:18:39Z + * @format date-time */ expires_at: string; }; @@ -24412,8 +24885,8 @@ export interface components { */ "org-membership": { /** - * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt + * @format uri */ url: string; /** @@ -24429,8 +24902,8 @@ export interface components { */ role: "admin" | "member" | "billing_manager"; /** - * Format: uri * @example https://api.github.com/orgs/octocat + * @format uri */ organization_url: string; organization: components["schemas"]["organization-simple"]; @@ -24445,8 +24918,8 @@ export interface components { */ migration: { /** - * Format: int64 * @example 79 + * @format int64 */ id: number; owner: components["schemas"]["nullable-simple-user"]; @@ -24465,22 +24938,22 @@ export interface components { /** @description The repositories included in the migration. Only returned for export migrations. */ repositories: components["schemas"]["repository"][]; /** - * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 + * @format uri */ url: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ updated_at: string; node_id: string; - /** Format: uri */ + /** @format uri */ archive_url?: string; /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; @@ -24491,20 +24964,25 @@ export interface components { */ "organization-role": { /** - * Format: int64 * @description The unique identifier of the role. + * @format int64 */ 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. */ + /** + * @nullable + * @description A short description about who this role is for or what permissions it grants. + */ description?: string | null; /** + * @nullable * @description The system role from which this role inherits permissions. * @enum {string|null} */ base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; /** + * @nullable * @description Source answers the question, "where did this role come from?" * @enum {string|null} */ @@ -24513,13 +24991,13 @@ export interface components { permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @description The date and time the role was created. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time the role was last updated. + * @format date-time */ updated_at: string; }; @@ -24538,6 +25016,7 @@ export interface components { node_id: string; name: string; slug: string; + /** @nullable */ description: string | null; privacy?: string; notification_setting?: string; @@ -24549,15 +25028,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; @@ -24574,9 +25053,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -24587,6 +25066,7 @@ export interface components { */ name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -24607,13 +25087,13 @@ export interface components { */ notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; /** @example justice-league */ @@ -24637,7 +25117,9 @@ export interface components { assignment?: "direct" | "indirect" | "mixed"; /** @description Team the user has gotten the role through */ inherited_from?: components["schemas"]["team-simple"][]; + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; @@ -24646,25 +25128,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -24674,25 +25159,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -24728,18 +25213,18 @@ export interface components { license?: string; description?: string; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ deleted_at?: string; /** Package Version Metadata */ @@ -24766,7 +25251,10 @@ export interface components { "organization-programmatic-access-grant-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */ id: number; - /** @description Reason for requesting access. */ + /** + * @nullable + * @description Reason for requesting access. + */ reason: string | null; owner: components["schemas"]["simple-user"]; /** @@ -24796,9 +25284,15 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** @@ -24836,9 +25330,15 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** @@ -24857,6 +25357,7 @@ export interface components { */ registry_type: "maven_repository"; /** + * @nullable * @description The username to use when authenticating with the private registry. * @example monalisa */ @@ -24866,9 +25367,9 @@ export interface components { * @enum {string} */ visibility: "all" | "private" | "selected"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24898,9 +25399,9 @@ export interface components { visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ selected_repository_ids?: number[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24909,23 +25410,23 @@ export interface components { */ project: { /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test + * @format uri */ owner_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604/columns + * @format uri */ columns_url: string; /** @example 1002604 */ @@ -24938,6 +25439,7 @@ export interface components { */ name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -24951,13 +25453,13 @@ export interface components { state: string; creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** @@ -24976,8 +25478,8 @@ export interface components { /** @description The name of the property */ property_name: string; /** - * Format: uri * @description The URL that can be used to fetch, update, or delete info about this property via the API. + * @format uri */ url?: string; /** @@ -24994,16 +25496,24 @@ export interface components { value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ default_value?: (string | string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; /** + * @nullable * @description Who can edit the values of the property * @example org_actors * @enum {string|null} @@ -25023,11 +25533,18 @@ export interface components { value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ default_value?: (string | string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ @@ -25040,7 +25557,10 @@ export interface components { "custom-property-value": { /** @description The name of the property */ property_name: string; - /** @description The value assigned to the property */ + /** + * @nullable + * @description The value assigned to the property + */ value: (string | string[]) | null; }; /** @@ -25059,13 +25579,14 @@ export interface components { }; /** * Repository + * @nullable * @description A repository on GitHub. */ "nullable-repository": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25093,16 +25614,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25124,28 +25648,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25167,13 +25691,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25187,30 +25711,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25218,25 +25742,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -25308,18 +25835,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -25420,8 +25950,8 @@ export interface components { */ "code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ url: string; /** @example citizen_code_of_conduct */ @@ -25429,8 +25959,9 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ html_url: string | null; }; @@ -25440,8 +25971,8 @@ export interface components { */ "full-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25453,16 +25984,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25484,28 +26018,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25527,13 +26061,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25547,30 +26081,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25578,25 +26112,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -25644,18 +26181,18 @@ export interface components { */ visibility?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string; permissions?: { @@ -25668,6 +26205,7 @@ export interface components { /** @example true */ allow_rebase_merge?: boolean; template_repository?: components["schemas"]["nullable-repository"]; + /** @nullable */ temp_clone_token?: string | null; /** @example true */ allow_squash_merge?: boolean; @@ -25757,7 +26295,10 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** + * @nullable + * @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -26238,16 +26779,18 @@ export interface components { /** @description The URL of the ruleset */ href?: string; }; + /** @nullable */ html?: { /** @description The html URL of the ruleset */ href?: string; } | null; }; + /** @nullable */ conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; rules?: components["schemas"]["repository-rule"][]; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }; /** @@ -26272,8 +26815,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string; /** @@ -26294,9 +26837,15 @@ export interface components { "rule-suite": { /** @description The unique identifier of the rule insight. */ id?: number; - /** @description The number that identifies the user. */ + /** + * @nullable + * @description The number that identifies the user. + */ actor_id?: number | null; - /** @description The handle for the GitHub user account. */ + /** + * @nullable + * @description The handle for the GitHub user account. + */ actor_name?: string | null; /** @description The first commit sha before the push evaluation. */ before_sha?: string; @@ -26309,8 +26858,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string; /** @@ -26319,6 +26868,7 @@ export interface components { */ result?: "pass" | "fail" | "bypass"; /** + * @nullable * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. * @enum {string|null} */ @@ -26328,9 +26878,15 @@ export interface components { rule_source?: { /** @description The type of rule source. */ type?: string; - /** @description The ID of the rule source. */ + /** + * @nullable + * @description The ID of the rule source. + */ id?: number | null; - /** @description The name of the rule source. */ + /** + * @nullable + * @description The name of the rule source. + */ name?: string | null; }; /** @@ -26345,23 +26901,41 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description The detailed failure message for the rule. Null if the rule passed. */ + /** + * @nullable + * @description The detailed failure message for the rule. Null if the rule passed. + */ details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions: string[] | null; }; /** @description A credit given to a user for a repository security advisory. */ @@ -26378,30 +26952,43 @@ export interface components { "repository-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id: string | null; /** - * Format: uri * @description The API URL for the advisory. + * @format uri */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** @description A short summary of the advisory. */ summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ description: string | null; /** + * @nullable * @description The severity of the advisory. * @enum {string|null} */ severity: "critical" | "high" | "medium" | "low" | null; - /** @description The author of the advisory. */ + /** + * @nullable + * @description The author of the advisory. + */ readonly author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ + /** + * @nullable + * @description The publisher of the advisory. + */ readonly publisher: components["schemas"]["simple-user"] | null; readonly identifiers: { /** @@ -26418,61 +27005,90 @@ export interface components { */ state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was created, in ISO 8601 format. + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was closed, in ISO 8601 format. + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; + /** @nullable */ readonly submission: { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; + /** @nullable */ vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + /** @nullable */ cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; + /** @nullable */ readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description A list of only the CWE IDs. */ + /** + * @nullable + * @description A list of only the CWE IDs. + */ cwe_ids: string[] | null; + /** @nullable */ credits: { /** @description The username of the user credited. */ login?: string; type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; + /** @nullable */ readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ + /** + * @nullable + * @description A list of users that collaborate on the advisory. + */ collaborating_users: components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ + /** + * @nullable + * @description A list of teams that collaborate on the advisory. + */ collaborating_teams: components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + /** + * @nullable + * @description A temporary private fork of the advisory's repository for collaborating on a fix. + */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; "actions-billing-usage": { @@ -26557,9 +27173,10 @@ export interface components { */ network_settings_ids?: string[]; /** - * Format: date-time + * @nullable * @description The time at which the network configuration was created, in ISO 8601 format. * @example 2024-04-26T11:31:07Z + * @format date-time */ created_on: string | null; }; @@ -26606,18 +27223,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -26630,25 +27247,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -26665,13 +27288,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** @example Organization */ @@ -26680,15 +27303,25 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; - /** @example 8 */ + /** + * @nullable + * @example 8 + */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -26698,10 +27331,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -26717,13 +27357,19 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ archived_at: string | null; }; /** @@ -26739,14 +27385,14 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** @@ -26756,7 +27402,10 @@ export interface components { name: string; /** @example justice-league */ slug: string; - /** @example A great team. */ + /** + * @nullable + * @example A great team. + */ description: string | null; /** * @description The level of privacy this team should have @@ -26778,8 +27427,8 @@ export interface components { /** @example https://api.github.com/organizations/1/team/1/members{/member} */ members_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; parent?: components["schemas"]["nullable-team-simple"]; @@ -26788,13 +27437,13 @@ export interface components { /** @example 10 */ repos_count: number; /** - * Format: date-time * @example 2017-07-14T16:53:42Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-08-17T12:37:15Z + * @format date-time */ updated_at: string; organization: components["schemas"]["team-organization"]; @@ -26825,20 +27474,23 @@ export interface components { /** @example 0 */ comments_count: number; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments + * @format uri */ comments_url: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ last_edited_at: string | null; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 + * @format uri */ html_url: string; /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ @@ -26859,8 +27511,8 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027 + * @format uri */ team_url: string; /** @@ -26869,13 +27521,13 @@ export interface components { */ title: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 + * @format uri */ url: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -26899,20 +27551,23 @@ export interface components { */ body_version: string; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ last_edited_at: string | null; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @format uri */ discussion_url: string; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @format uri */ html_url: string; /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ @@ -26923,13 +27578,13 @@ export interface components { */ number: number; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + * @format uri */ url: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -26951,8 +27606,8 @@ export interface components { */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** - * Format: date-time * @example 2016-05-20T20:09:31Z + * @format date-time */ created_at: string; }; @@ -26961,7 +27616,7 @@ export interface components { * @description Team Membership */ "team-membership": { - /** Format: uri */ + /** @format uri */ url: string; /** * @description The role of the user in the team. @@ -26988,6 +27643,7 @@ export interface components { id: number; node_id: string; name: string; + /** @nullable */ body: string | null; number: number; state: string; @@ -27041,16 +27697,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -27072,28 +27731,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -27115,13 +27774,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -27135,30 +27794,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -27166,25 +27825,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -27246,18 +27908,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -27315,29 +27980,32 @@ export interface components { */ "project-card": { /** - * Format: uri * @example https://api.github.com/projects/columns/cards/1478 + * @format uri */ url: string; /** - * Format: int64 * @description The project card's ID * @example 42 + * @format int64 */ id: number; /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ node_id: string; - /** @example Add payload for delete Project column */ + /** + * @nullable + * @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 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2016-09-05T14:20:22Z + * @format date-time */ updated_at: string; /** @@ -27348,18 +28016,18 @@ export interface components { column_name?: string; project_id?: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ column_url: string; /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 + * @format uri */ content_url?: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ project_url: string; }; @@ -27369,18 +28037,18 @@ export interface components { */ "project-column": { /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ project_url: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367/cards + * @format uri */ cards_url: string; /** @@ -27396,13 +28064,13 @@ export interface components { */ name: string; /** - * Format: date-time * @example 2016-09-05T14:18:44Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2016-09-05T14:22:28Z + * @format date-time */ updated_at: string; }; @@ -27466,12 +28134,22 @@ export interface components { archive_download_url: string; /** @description Whether or not the artifact has expired. */ expired: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; + /** @nullable */ workflow_run?: { /** @example 10 */ id?: number; @@ -27506,13 +28184,13 @@ export interface components { /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ version?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ last_accessed_at?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at?: string; /** @example 1024 */ @@ -27550,7 +28228,10 @@ export interface components { head_sha: string; /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ html_url: string | null; /** * @description The phase of the lifecycle that the job is currently in. @@ -27559,27 +28240,29 @@ export interface components { */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @description The outcome of the job. * @example success * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time * @description The time that the job created, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ started_at: string; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ completed_at: string | null; /** @@ -27596,6 +28279,7 @@ export interface components { */ status: "queued" | "in_progress" | "completed"; /** + * @nullable * @description The outcome of the job. * @example success */ @@ -27608,15 +28292,17 @@ export interface components { /** @example 1 */ number: number; /** - * Format: date-time + * @nullable * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ started_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ completed_at?: string | null; }[]; @@ -27632,31 +28318,37 @@ export interface components { */ labels: string[]; /** + * @nullable * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ runner_id: number | null; /** + * @nullable * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ runner_name: string | null; /** + * @nullable * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ runner_group_id: number | null; /** + * @nullable * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ runner_group_name: string | null; /** + * @nullable * @description The name of the workflow. * @example Build */ workflow_name: string | null; /** + * @nullable * @description The name of the current branch. * @example main */ @@ -27682,9 +28374,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** Actions Variable */ @@ -27700,15 +28392,15 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ updated_at: string; }; @@ -27740,7 +28432,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { - /** Format: int64 */ + /** @format int64 */ id: number; number: number; url: string; @@ -27748,7 +28440,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -27758,7 +28450,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -27767,6 +28459,7 @@ export interface components { }; /** * Simple Commit + * @nullable * @description A commit. */ "nullable-simple-commit": { @@ -27783,12 +28476,15 @@ export interface components { */ message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ author: { /** * @description Name of the commit's author @@ -27796,13 +28492,16 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ committer: { /** * @description Name of the commit's committer @@ -27810,9 +28509,9 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; @@ -27828,6 +28527,7 @@ export interface components { */ id: number; /** + * @nullable * @description The name of the workflow run. * @example Build */ @@ -27844,7 +28544,10 @@ export interface components { * @example MDEwOkNoZWNrU3VpdGU0Mg== */ check_suite_node_id?: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that points to the version of the workflow being run. @@ -27866,12 +28569,19 @@ export interface components { * @example 1 */ run_attempt?: number; + /** @nullable */ referenced_workflows?: components["schemas"]["referenced-workflow"][] | null; /** @example push */ event: string; - /** @example completed */ + /** + * @nullable + * @example completed + */ status: string | null; - /** @example neutral */ + /** + * @nullable + * @example neutral + */ conclusion: string | null; /** * @description The ID of the parent workflow. @@ -27885,17 +28595,20 @@ export interface components { url: string; /** @example https://github.com/github/hello-world/suites/4 */ html_url: string; - /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */ + /** + * @nullable + * @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. + */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; actor?: components["schemas"]["simple-user"]; triggering_actor?: components["schemas"]["simple-user"]; /** - * Format: date-time * @description The start time of the latest run. Resets on re-run. + * @format date-time */ run_started_at?: string; /** @@ -27929,6 +28642,7 @@ export interface components { */ rerun_url: string; /** + * @nullable * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ @@ -27973,15 +28687,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url?: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ created_at?: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ updated_at?: string; }[]; @@ -28028,9 +28742,9 @@ export interface components { "pending-deployment": { environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -28051,9 +28765,10 @@ export interface components { */ wait_timer: number; /** - * Format: date-time + * @nullable * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z + * @format date-time */ wait_timer_started_at: string | null; /** @@ -28073,14 +28788,14 @@ export interface components { */ deployment: { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ url: string; /** - * Format: int64 * @description Unique identifier of the deployment * @example 42 + * @format int64 */ id: number; /** @example MDEwOkRlcGxveW1lbnQx */ @@ -28107,27 +28822,30 @@ export interface components { * @example production */ environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** @@ -28194,13 +28912,13 @@ export interface components { */ state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ updated_at: string; /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ @@ -28210,8 +28928,8 @@ export interface components { /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ badge_url: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ deleted_at?: string; }; @@ -28257,9 +28975,9 @@ export interface components { */ ref: string; /** - * Format: date-time * @description The time when the activity occurred. * @example 2011-01-26T19:06:43Z + * @format date-time */ timestamp: string; /** @@ -28319,6 +29037,7 @@ export interface components { contexts: string[]; checks: { context: string; + /** @nullable */ app_id: number | null; }[]; contexts_url?: string; @@ -28330,8 +29049,8 @@ export interface components { */ "protected-branch-admin-enforced": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + * @format uri */ url: string; /** @example true */ @@ -28343,8 +29062,8 @@ export interface components { */ "protected-branch-pull-request-review": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + * @format uri */ url?: string; dismissal_restrictions?: { @@ -28388,17 +29107,17 @@ export interface components { * @description Branch Restriction Policy */ "branch-restriction-policy": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ apps_url: string; users: { login?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -28425,12 +29144,14 @@ export interface components { html_url?: string; name?: string; slug?: string; + /** @nullable */ description?: string | null; privacy?: string; notification_setting?: string; permission?: string; members_url?: string; repositories_url?: string; + /** @nullable */ parent?: string | null; }[]; apps: { @@ -28523,8 +29244,8 @@ export interface components { protection_url?: string; required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ url: string; /** @example true */ @@ -28549,16 +29270,17 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; protected: boolean; protection?: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url?: string; }; /** * Git User + * @nullable * @description Metaproperties for Git author/committer information. */ "nullable-git-user": { @@ -28573,8 +29295,11 @@ export interface components { verification: { verified: boolean; reason: string; + /** @nullable */ payload: string | null; + /** @nullable */ signature: string | null; + /** @nullable */ verified_at?: string | null; }; /** @@ -28598,18 +29323,18 @@ export interface components { /** @example 124 */ changes: number; /** - * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ blob_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ raw_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ contents_url: string; /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ @@ -28623,8 +29348,8 @@ export interface components { */ commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ url: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ @@ -28632,19 +29357,19 @@ export interface components { /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + * @format uri */ comments_url: string; commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ url: string; author: components["schemas"]["nullable-git-user"]; @@ -28657,26 +29382,28 @@ export interface components { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + * @format uri */ url: string; }; verification?: components["schemas"]["verification"]; }; + /** @nullable */ author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + /** @nullable */ committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ html_url?: string; }[]; @@ -28696,12 +29423,12 @@ export interface components { commit: components["schemas"]["commit"]; _links: { html: string; - /** Format: uri */ + /** @format uri */ self: string; }; protected: boolean; protection: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url: string; /** @example "mas*" */ pattern?: string; @@ -28714,8 +29441,8 @@ export interface components { */ "status-check-policy": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + * @format uri */ url: string; /** @example true */ @@ -28729,11 +29456,12 @@ export interface components { checks: { /** @example continuous-integration/travis-ci */ context: string; + /** @nullable */ app_id: number | null; }[]; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + * @format uri */ contexts_url: string; }; @@ -28742,11 +29470,11 @@ export interface components { * @description Branch protections protect branches */ "protected-branch": { - /** Format: uri */ + /** @format uri */ url: string; required_status_checks?: components["schemas"]["status-check-policy"]; required_pull_request_reviews?: { - /** Format: uri */ + /** @format uri */ url: string; dismiss_stale_reviews?: boolean; require_code_owner_reviews?: boolean; @@ -28757,11 +29485,11 @@ export interface components { */ require_last_push_approval: boolean; dismissal_restrictions?: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; users: components["schemas"]["simple-user"][]; teams: components["schemas"]["team"][]; @@ -28775,15 +29503,15 @@ export interface components { }; required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ url: string; /** @example true */ enabled: boolean; }; enforce_admins?: { - /** Format: uri */ + /** @format uri */ url: string; enabled: boolean; }; @@ -28820,8 +29548,8 @@ export interface components { */ "deployment-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ url: string; /** @@ -28843,26 +29571,29 @@ export interface components { * @example production */ environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ description: string | null; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** @@ -28883,9 +29614,9 @@ export interface components { */ "check-run": { /** - * Format: int64 * @description The id of the check. * @example 21 + * @format int64 */ id: number; /** @@ -28895,13 +29626,22 @@ export interface components { head_sha: string; /** @example MDg6Q2hlY2tSdW40 */ node_id: string; - /** @example 42 */ + /** + * @nullable + * @example 42 + */ external_id: string | null; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ html_url: string | null; - /** @example https://example.com */ + /** + * @nullable + * @example https://example.com + */ details_url: string | null; /** * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. @@ -28910,26 +29650,32 @@ export interface components { */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ started_at: string | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ completed_at: string | null; output: { + /** @nullable */ title: string | null; + /** @nullable */ summary: string | null; + /** @nullable */ text: string | null; annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; }; /** @@ -28937,6 +29683,7 @@ export interface components { * @example test-coverage */ name: string; + /** @nullable */ check_suite: { id: number; } | null; @@ -28956,17 +29703,35 @@ export interface components { start_line: number; /** @example 2 */ end_line: number; - /** @example 5 */ + /** + * @nullable + * @example 5 + */ start_column: number | null; - /** @example 10 */ + /** + * @nullable + * @example 10 + */ end_column: number | null; - /** @example warning */ + /** + * @nullable + * @example warning + */ annotation_level: string | null; - /** @example Spell Checker */ + /** + * @nullable + * @example Spell Checker + */ title: string | null; - /** @example Check your spelling for 'banaas'. */ + /** + * @nullable + * @example Check your spelling for 'banaas'. + */ message: string | null; - /** @example Do you mean 'bananas' or 'banana'? */ + /** + * @nullable + * @example Do you mean 'bananas' or 'banana'? + */ raw_details: string | null; blob_href: string; }; @@ -28988,12 +29753,15 @@ export interface components { */ message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ author: { /** * @description Name of the commit's author @@ -29001,13 +29769,16 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ committer: { /** * @description Name of the commit's committer @@ -29015,9 +29786,9 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; @@ -29028,13 +29799,16 @@ export interface components { */ "check-suite": { /** - * Format: int64 * @example 5 + * @format int64 */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that is being checked. @@ -29042,28 +29816,46 @@ export interface components { */ head_sha: string; /** + * @nullable * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; - /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ + /** + * @nullable + * @example https://api.github.com/repos/github/hello-world/check-suites/5 + */ url: string | null; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ before: string | null; - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ after: string | null; + /** @nullable */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; app: components["schemas"]["nullable-integration"]; repository: components["schemas"]["minimal-repository"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; head_commit: components["schemas"]["simple-commit"]; latest_check_runs_count: number; @@ -29102,16 +29894,21 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; "code-scanning-alert-rule": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -29120,11 +29917,20 @@ export interface components { description?: string; /** @description A description of the rule used to detect the alert. */ full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; }; "code-scanning-alert": { @@ -29154,11 +29960,14 @@ export interface components { * @enum {string} */ "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; - /** @description The description of an autofix. */ + /** + * @nullable + * @description The description of an autofix. + */ "code-scanning-autofix-description": string | null; /** - * Format: date-time * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-autofix-started-at": string; "code-scanning-autofix": { @@ -29166,7 +29975,10 @@ export interface components { description: components["schemas"]["code-scanning-autofix-description"]; started_at: components["schemas"]["code-scanning-autofix-started-at"]; }; - /** @description Commit an autofix for a code scanning alert */ + /** + * @nullable + * @description Commit an autofix for a code scanning alert + */ "code-scanning-autofix-commits": { /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ target_ref?: string; @@ -29184,18 +29996,21 @@ export interface components { * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ "code-scanning-analysis-sarif-id": string; - /** @description The SHA of the commit to which the analysis you are uploading relates. */ + /** + * @description The SHA of the commit to which the analysis you are uploading relates. + * @pattern ^[0-9a-fA-F]+$ + */ "code-scanning-analysis-commit-sha": string; /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ "code-scanning-analysis-environment": string; /** - * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-analysis-created-at": string; /** - * Format: uri * @description The REST API URL of the analysis resource. + * @format uri */ "code-scanning-analysis-url": string; "code-scanning-analysis": { @@ -29229,13 +30044,15 @@ export interface components { */ "code-scanning-analysis-deletion": { /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, without last analysis deletion confirmation + * @format uri */ readonly next_analysis_url: string | null; /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, with last analysis deletion confirmation + * @format uri */ readonly confirm_delete_url: string | null; }; @@ -29256,21 +30073,24 @@ export interface components { /** @description The size of the CodeQL database file in bytes. */ size: number; /** - * Format: date-time * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** - * Format: uri * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. + * @format uri */ url: string; - /** @description The commit SHA of the repository at the time the CodeQL database was created. */ + /** + * @nullable + * @description The commit SHA of the repository at the time the CodeQL database was created. + */ commit_oid?: string | null; }; /** @@ -29303,8 +30123,9 @@ export interface components { /** @example 80 */ stargazers_count: number; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; }; @@ -29335,18 +30156,19 @@ export interface components { /** @description The download url for the query pack. */ query_pack_url: string; /** - * Format: date-time * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at?: string; /** - * Format: date-time * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at?: string; /** - * Format: date-time + * @nullable * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + * @format date-time */ completed_at?: string | null; /** @enum {string} */ @@ -29410,11 +30232,13 @@ export interface components { /** @description Languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** + * @nullable * @description Runner type to be used. * @enum {string|null} */ runner_type?: "standard" | "labeled" | null; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29425,12 +30249,14 @@ export interface components { */ query_suite?: "default" | "extended"; /** - * Format: date-time + * @nullable * @description Timestamp of latest configuration update. * @example 2023-12-06T14:20:20.000Z + * @format date-time */ updated_at?: string | null; /** + * @nullable * @description The frequency of the periodic analysis. * @enum {string|null} */ @@ -29449,6 +30275,7 @@ export interface components { */ runner_type?: "standard" | "labeled"; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29475,6 +30302,7 @@ export interface components { * @description The full Git reference, formatted as `refs/heads/`, * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main + * @pattern ^refs/(heads|tags|pull)/.*$ */ "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)." */ @@ -29482,8 +30310,8 @@ export interface components { "code-scanning-sarifs-receipt": { id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** - * Format: uri * @description The REST API URL for checking the status of the upload. + * @format uri */ readonly url?: string; }; @@ -29494,11 +30322,15 @@ export interface components { */ processing_status?: "pending" | "complete" | "failed"; /** - * Format: uri + * @nullable * @description The REST API URL for getting the analyses associated with the upload. + * @format uri */ readonly analyses_url?: string | null; - /** @description Any errors that ocurred during processing of the delivery. */ + /** + * @nullable + * @description Any errors that ocurred during processing of the delivery. + */ readonly errors?: string[] | null; }; /** @description Code security configuration associated with a repository and attachment status */ @@ -29537,6 +30369,7 @@ export interface components { */ kind: string; /** + * @nullable * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. * @example The pattern `/` will never match anything, did you mean `*` instead? */ @@ -29592,6 +30425,7 @@ export interface components { */ cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -29619,9 +30453,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -29632,34 +30466,39 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29669,25 +30508,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -29711,9 +30550,9 @@ export interface components { */ "repository-invitation": { /** - * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 + * @format int64 */ id: number; repository: components["schemas"]["minimal-repository"]; @@ -29726,8 +30565,8 @@ export interface components { */ permissions: "read" | "write" | "admin" | "triage" | "maintain"; /** - * Format: date-time * @example 2016-06-13T14:52:50-05:00 + * @format date-time */ created_at: string; /** @description Whether or not the invitation has expired */ @@ -29743,40 +30582,46 @@ export interface components { }; /** * Collaborator + * @nullable * @description Collaborator */ "nullable-collaborator": { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29786,25 +30631,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -29837,21 +30682,24 @@ export interface components { * @description Commit Comment */ "commit-comment": { - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ url: string; id: number; node_id: string; body: string; + /** @nullable */ path: string | null; + /** @nullable */ position: number | null; + /** @nullable */ line: number | null; commit_id: string; user: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -29877,6 +30725,7 @@ export interface components { }; /** * Auto merge + * @nullable * @description The status of auto merging a pull request. */ "auto-merge": { @@ -29897,57 +30746,57 @@ export interface components { */ "pull-request-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ statuses_url: string; /** @example 1347 */ @@ -29959,10 +30808,13 @@ export interface components { /** @example new-feature */ title: string; user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; @@ -29972,33 +30824,44 @@ export interface components { default: boolean; }[]; milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ merge_commit_sha: string | null; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_reviewers?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_teams?: components["schemas"]["team"][] | null; head: { label: string; @@ -30034,21 +30897,29 @@ export interface components { }; /** Simple Commit Status */ "simple-commit-status": { + /** @nullable */ description: string | null; id: number; node_id: string; state: string; context: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ target_url: string | null; + /** @nullable */ required?: boolean | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ avatar_url: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30061,9 +30932,9 @@ export interface components { sha: string; total_count: number; repository: components["schemas"]["minimal-repository"]; - /** Format: uri */ + /** @format uri */ commit_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -30072,11 +30943,14 @@ export interface components { */ status: { url: string; + /** @nullable */ avatar_url: string | null; id: number; node_id: string; state: string; + /** @nullable */ description: string | null; + /** @nullable */ target_url: string | null; context: string; created_at: string; @@ -30085,12 +30959,13 @@ export interface components { }; /** * Code Of Conduct Simple + * @nullable * @description Code of Conduct Simple */ "nullable-code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ url: string; /** @example citizen_code_of_conduct */ @@ -30098,16 +30973,20 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ html_url: string | null; } | null; - /** Community Health File */ + /** + * Community Health File + * @nullable + */ "nullable-community-health-file": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; } | null; /** @@ -30117,9 +30996,15 @@ export interface components { "community-profile": { /** @example 100 */ health_percentage: number; - /** @example My first repository on GitHub! */ + /** + * @nullable + * @example My first repository on GitHub! + */ description: string | null; - /** @example example.com */ + /** + * @nullable + * @example example.com + */ documentation: string | null; files: { code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; @@ -30131,8 +31016,9 @@ export interface components { pull_request_template: components["schemas"]["nullable-community-health-file"]; }; /** - * Format: date-time + * @nullable * @example 2017-02-28T19:09:29Z + * @format date-time */ updated_at: string | null; /** @example true */ @@ -30144,28 +31030,28 @@ export interface components { */ "commit-comparison": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + * @format uri */ permalink_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch + * @format uri */ patch_url: string; base_commit: components["schemas"]["commit"]; @@ -30195,13 +31081,22 @@ export interface components { path: string; sha: string; content?: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; entries?: { type: string; @@ -30209,29 +31104,50 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30247,20 +31163,35 @@ export interface components { path: string; content?: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; @@ -30280,20 +31211,35 @@ export interface components { path: string; content: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; /** @example "actual/actual.md" */ @@ -30316,20 +31262,35 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30343,26 +31304,41 @@ export interface components { * @enum {string} */ type: "submodule"; - /** Format: uri */ + /** @format uri */ submodule_git_url: string; size: number; name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30371,6 +31347,7 @@ export interface components { * @description File Commit */ "file-commit": { + /** @nullable */ content: { name?: string; path?: string; @@ -30415,8 +31392,11 @@ export interface components { verification?: { verified?: boolean; reason?: string; + /** @nullable */ signature?: string | null; + /** @nullable */ payload?: string | null; + /** @nullable */ verified_at?: string | null; }; }; @@ -30445,26 +31425,27 @@ export interface components { login?: string; id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ avatar_url?: string; + /** @nullable */ gravatar_id?: string | null; - /** Format: uri */ + /** @format uri */ url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; following_url?: string; gists_url?: string; starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; events_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; type: string; site_admin?: boolean; @@ -30487,6 +31468,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -30501,11 +31483,15 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; @@ -30520,9 +31506,9 @@ export interface components { * @example MY_ARTIFACTORY_PASSWORD */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30540,11 +31526,20 @@ export interface components { name: string; /** @example 1.0.0 */ version: string; - /** @example pkg:/npm/%40actions/core@1.1.0 */ + /** + * @nullable + * @example pkg:/npm/%40actions/core@1.1.0 + */ package_url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ license: string | null; - /** @example https://github.com/github/actions */ + /** + * @nullable + * @example https://github.com/github/actions + */ source_repository_url: string | null; vulnerabilities: { /** @example critical */ @@ -30699,6 +31694,7 @@ export interface components { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. * @example pkg:/npm/%40actions/http-client@1.0.11 + * @pattern ^pkg */ package_url?: string; metadata?: components["schemas"]["metadata"]; @@ -30771,6 +31767,7 @@ export interface components { /** * @description The repository branch that triggered this snapshot. * @example refs/heads/main + * @pattern ^refs/ */ ref: string; /** @description A description of the detector used. */ @@ -30797,9 +31794,9 @@ export interface components { [key: string]: components["schemas"]["manifest"]; }; /** - * Format: date-time * @description The time at which the snapshot was scanned. * @example 2020-06-13T14:52:50-05:00 + * @format date-time */ scanned: string; }; @@ -30809,13 +31806,13 @@ export interface components { */ "deployment-status": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ @@ -30840,44 +31837,44 @@ export interface components { */ environment: string; /** - * Format: uri * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ target_url: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 + * @format uri */ deployment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** - * Format: uri * @description The URL for accessing your environment. * @default * @example https://staging.example.com/ + * @format uri */ environment_url: string; /** - * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -30887,7 +31884,10 @@ export interface components { * @example 30 */ "wait-timer": number; - /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ + /** + * @nullable + * @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. + */ "deployment-branch-policy-settings": { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ protected_branches: boolean; @@ -30900,9 +31900,9 @@ export interface components { */ environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ id: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -30917,15 +31917,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ updated_at: string; /** @description Built-in deployment protection rules for the environment. */ @@ -31084,9 +32084,10 @@ export interface components { blob: { content: string; encoding: string; - /** Format: uri */ + /** @format uri */ url: string; sha: string; + /** @nullable */ size: number | null; node_id: string; highlighted_content?: string; @@ -31102,14 +32103,14 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -31126,9 +32127,9 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -31153,7 +32154,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -31162,19 +32163,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { verified: boolean; reason: string; + /** @nullable */ signature: string | null; + /** @nullable */ payload: string | null; + /** @nullable */ verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -31184,7 +32188,7 @@ export interface components { "git-ref": { ref: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; object: { type: string; @@ -31193,7 +32197,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; }; @@ -31212,9 +32216,9 @@ export interface components { /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ sha: string; /** - * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + * @format uri */ url: string; /** @@ -31230,7 +32234,7 @@ export interface components { object: { sha: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; }; verification?: components["schemas"]["verification"]; @@ -31241,7 +32245,7 @@ export interface components { */ "git-tree": { sha: string; - /** Format: uri */ + /** @format uri */ url: string; truncated: boolean; /** @@ -31302,8 +32306,11 @@ export interface components { }; /** Hook Response */ "hook-response": { + /** @nullable */ code: number | null; + /** @nullable */ status: string | null; + /** @nullable */ message: string | null; }; /** @@ -31337,33 +32344,33 @@ export interface components { events: string[]; config: components["schemas"]["webhook-config"]; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test + * @format uri */ test_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + * @format uri */ ping_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries + * @format uri */ deliveries_url?: string; last_response: components["schemas"]["hook-response"]; @@ -31373,6 +32380,7 @@ export interface components { * @description A repository import from an external source. */ import: { + /** @nullable */ vcs: string | null; use_lfs?: boolean; /** @description The URL of the originating repository. */ @@ -31381,11 +32389,17 @@ export interface components { tfvc_project?: string; /** @enum {string} */ status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; + /** @nullable */ status_text?: string | null; + /** @nullable */ failed_step?: string | null; + /** @nullable */ error_message?: string | null; + /** @nullable */ import_percent?: number | null; + /** @nullable */ commit_count?: number | null; + /** @nullable */ push_percent?: number | null; has_large_files?: boolean; large_files_size?: number; @@ -31396,14 +32410,15 @@ export interface components { human_name?: string; }[]; message?: string; + /** @nullable */ authors_count?: number | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ authors_url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; svn_root?: string; }; @@ -31417,9 +32432,9 @@ export interface components { remote_name: string; email: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ import_url: string; }; /** @@ -31434,26 +32449,27 @@ export interface components { }; /** * Issue + * @nullable * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ "nullable-issue": { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -31466,6 +32482,7 @@ export interface components { */ state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -31477,6 +32494,7 @@ export interface components { */ title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -31490,45 +32508,67 @@ export interface components { * ] */ labels: (string | { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ url?: string; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; default?: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; comments: number; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; draft?: boolean; closed_by?: components["schemas"]["nullable-simple-user"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -31541,14 +32581,18 @@ export interface components { * @description Issue Event Label */ "issue-event-label": { + /** @nullable */ name: string | null; + /** @nullable */ color: string | null; }; /** Issue Event Dismissed Review */ "issue-event-dismissed-review": { state: string; review_id: number; + /** @nullable */ dismissal_message: string | null; + /** @nullable */ dismissal_commit_id?: string | null; }; /** @@ -31563,10 +32607,10 @@ export interface components { * @description Issue Event Project Card */ "issue-event-project-card": { - /** Format: uri */ + /** @format uri */ url: string; id: number; - /** Format: uri */ + /** @format uri */ project_url: string; project_id: number; column_name: string; @@ -31586,27 +32630,33 @@ export interface components { */ "issue-event": { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDEwOklzc3VlRXZlbnQx */ node_id: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 + * @format uri */ url: string; actor: components["schemas"]["nullable-simple-user"]; /** @example closed */ event: string; - /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e + */ commit_id: string | null; - /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ commit_url: string | null; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; issue?: components["schemas"]["nullable-issue"]; @@ -31621,6 +32671,7 @@ export interface components { project_card?: components["schemas"]["issue-event-project-card"]; rename?: components["schemas"]["issue-event-rename"]; author_association?: components["schemas"]["author-association"]; + /** @nullable */ lock_reason?: string | null; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; @@ -31634,7 +32685,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31653,7 +32706,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31672,7 +32727,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["integration"]; @@ -31689,7 +32746,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31706,7 +32765,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31724,7 +32785,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31742,7 +32805,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31761,7 +32826,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31779,7 +32846,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31797,13 +32866,16 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; dismissed_review: { state: string; review_id: number; + /** @nullable */ dismissal_message: string | null; dismissal_commit_id?: string; }; @@ -31818,11 +32890,16 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; - /** @example "off-topic" */ + /** + * @nullable + * @example "off-topic" + */ lock_reason: string | null; }; /** @@ -31835,16 +32912,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31860,16 +32939,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31885,16 +32966,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31910,16 +32993,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31936,17 +33021,17 @@ export interface components { */ label: { /** - * Format: int64 * @description Unique identifier for the label. * @example 208045946 + * @format int64 */ id: number; /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ node_id: string; /** - * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug + * @format uri */ url: string; /** @@ -31955,6 +33040,7 @@ export interface components { */ name: string; /** + * @nullable * @description Optional description of the label, such as its purpose. * @example Something isn't working */ @@ -31984,9 +33070,9 @@ export interface components { id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ url: string; /** @@ -31996,20 +33082,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -32022,9 +33108,9 @@ export interface components { "timeline-cross-referenced-event": { event: string; actor?: components["schemas"]["simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; source: { type?: string; @@ -32043,14 +33129,14 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -32067,9 +33153,9 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -32094,7 +33180,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -32103,19 +33189,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { verified: boolean; reason: string; + /** @nullable */ signature: string | null; + /** @nullable */ payload: string | null; + /** @nullable */ verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -32133,6 +33222,7 @@ export interface components { node_id: string; user: components["schemas"]["simple-user"]; /** + * @nullable * @description The text of the review. * @example This looks great. */ @@ -32140,13 +33230,13 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ pull_request_url: string; _links: { @@ -32157,7 +33247,7 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** * @description A commit SHA for the review. @@ -32179,15 +33269,16 @@ export interface components { */ url: string; /** - * Format: int64 + * @nullable * @description The ID of the pull request review to which the comment belongs. * @example 42 + * @format int64 */ pull_request_review_id: number | null; /** - * Format: int64 * @description The ID of the pull request review comment. * @example 1 + * @format int64 */ id: number; /** @@ -32237,62 +33328,65 @@ export interface components { */ body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; /** - * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ html_url: string; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ pull_request_url: string; author_association: components["schemas"]["author-association"]; _links: { self: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ href: string; }; html: { /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ href: string; }; pull_request: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ href: string; }; }; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ start_line?: number | null; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ original_start_line?: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -32354,7 +33448,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32370,7 +33466,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32386,10 +33484,13 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; + /** @nullable */ state_reason?: string | null; }; /** @@ -32409,7 +33510,9 @@ export interface components { verified: boolean; created_at: string; read_only: boolean; + /** @nullable */ added_by?: string | null; + /** @nullable */ last_used?: string | null; enabled?: boolean; }; @@ -32429,23 +33532,38 @@ export interface components { path: string; sha: string; size: number; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; type: string; content: string; encoding: string; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; license: components["schemas"]["nullable-license-simple"]; @@ -32466,18 +33584,18 @@ export interface components { */ milestone: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ labels_url: string; /** @example 1002604 */ @@ -32501,7 +33619,10 @@ export interface components { * @example v1.0 */ title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -32509,23 +33630,25 @@ export interface components { /** @example 8 */ closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ due_on: string | null; }; @@ -32551,7 +33674,7 @@ export interface components { * ] */ domains: string[]; - /** Format: date */ + /** @format date */ expires_at?: string; }; /** @@ -32560,31 +33683,35 @@ export interface components { */ page: { /** - * Format: uri * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages + * @format uri */ url: string; /** + * @nullable * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ status: "built" | "building" | "errored" | null; /** + * @nullable * @description The Pages site's custom domain * @example example.com */ cname: string | null; /** + * @nullable * @description The state if the domain is verified * @example pending * @enum {string|null} */ protected_domain_state?: "pending" | "verified" | "unverified" | null; /** - * Format: date-time + * @nullable * @description The timestamp when a pending domain becomes unverified. + * @format date-time */ pending_domain_unverified_at?: string | null; /** @@ -32594,12 +33721,13 @@ export interface components { */ custom_404: boolean; /** - * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com + * @format uri */ html_url?: string; /** + * @nullable * @description The process in which the Page will be built. * @example legacy * @enum {string|null} @@ -32623,18 +33751,19 @@ export interface components { * @description Page Build */ "page-build": { - /** Format: uri */ + /** @format uri */ url: string; status: string; error: { + /** @nullable */ message: string | null; }; pusher: components["schemas"]["nullable-simple-user"]; commit: string; duration: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -32643,8 +33772,8 @@ export interface components { */ "page-build-status": { /** - * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest + * @format uri */ url: string; /** @example queued */ @@ -32658,21 +33787,21 @@ export interface components { /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ id: number | string; /** - * Format: uri * @description The URI to monitor GitHub Pages deployment status. * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 + * @format uri */ status_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages. * @example hello-world.github.io + * @format uri */ page_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages preview. * @example monalisa-1231a2312sa32-23sda74.drafts.github.io + * @format uri */ preview_url?: string; }; @@ -32694,59 +33823,96 @@ export interface components { uri?: string; nameservers?: string; dns_resolves?: boolean; + /** @nullable */ is_proxied?: boolean | null; + /** @nullable */ is_cloudflare_ip?: boolean | null; + /** @nullable */ is_fastly_ip?: boolean | null; + /** @nullable */ is_old_ip_address?: boolean | null; + /** @nullable */ is_a_record?: boolean | null; + /** @nullable */ has_cname_record?: boolean | null; + /** @nullable */ has_mx_records_present?: boolean | null; is_valid_domain?: boolean; is_apex_domain?: boolean; + /** @nullable */ should_be_a_record?: boolean | null; + /** @nullable */ is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ is_cname_to_fastly?: boolean | null; + /** @nullable */ is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ is_non_github_pages_ip_present?: boolean | null; is_pages_domain?: boolean; + /** @nullable */ is_served_by_pages?: boolean | null; is_valid?: boolean; + /** @nullable */ reason?: string | null; responds_to_https?: boolean; enforces_https?: boolean; + /** @nullable */ https_error?: string | null; + /** @nullable */ is_https_eligible?: boolean | null; + /** @nullable */ caa_error?: string | null; }; + /** @nullable */ alt_domain?: { host?: string; uri?: string; nameservers?: string; dns_resolves?: boolean; + /** @nullable */ is_proxied?: boolean | null; + /** @nullable */ is_cloudflare_ip?: boolean | null; + /** @nullable */ is_fastly_ip?: boolean | null; + /** @nullable */ is_old_ip_address?: boolean | null; + /** @nullable */ is_a_record?: boolean | null; + /** @nullable */ has_cname_record?: boolean | null; + /** @nullable */ has_mx_records_present?: boolean | null; is_valid_domain?: boolean; is_apex_domain?: boolean; + /** @nullable */ should_be_a_record?: boolean | null; + /** @nullable */ is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ is_cname_to_fastly?: boolean | null; + /** @nullable */ is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ is_non_github_pages_ip_present?: boolean | null; is_pages_domain?: boolean; + /** @nullable */ is_served_by_pages?: boolean | null; is_valid?: boolean; + /** @nullable */ reason?: string | null; responds_to_https?: boolean; enforces_https?: boolean; + /** @nullable */ https_error?: string | null; + /** @nullable */ is_https_eligible?: boolean | null; + /** @nullable */ caa_error?: string | null; } | null; }; @@ -32756,57 +33922,57 @@ export interface components { */ "pull-request": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ statuses_url: string; /** @@ -32828,46 +33994,61 @@ export interface components { */ title: string; user: components["schemas"]["simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; name: string; + /** @nullable */ description: string | null; color: string; default: boolean; }[]; milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ merge_commit_sha: string | null; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_reviewers?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_teams?: components["schemas"]["team-simple"][] | null; head: { label: string; @@ -32901,9 +34082,15 @@ export interface components { */ draft?: boolean; merged: boolean; - /** @example true */ + /** + * @nullable + * @example true + */ mergeable: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ rebaseable?: boolean | null; /** @example clean */ mergeable_state: string; @@ -32949,9 +34136,9 @@ export interface components { */ "pull-request-review": { /** - * Format: int64 * @description Unique identifier of the review * @example 42 + * @format int64 */ id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ @@ -32965,13 +34152,13 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ pull_request_url: string; _links: { @@ -32982,9 +34169,10 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** + * @nullable * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ @@ -32999,18 +34187,19 @@ export interface components { */ "review-comment": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ url: string; /** - * Format: int64 + * @nullable * @example 42 + * @format int64 */ pull_request_review_id: number | null; /** - * Format: int64 * @example 10 + * @format int64 */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ @@ -33019,7 +34208,10 @@ export interface components { diff_hunk: string; /** @example file1.txt */ path: string; - /** @example 1 */ + /** + * @nullable + * @example 1 + */ position: number | null; /** @example 4 */ original_position: number; @@ -33033,23 +34225,23 @@ export interface components { /** @example Great stuff */ body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ pull_request_url: string; author_association: components["schemas"]["author-association"]; @@ -33068,6 +34260,7 @@ export interface components { */ side: "LEFT" | "RIGHT"; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -33084,11 +34277,13 @@ export interface components { */ original_line?: number; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ start_line?: number | null; /** + * @nullable * @description The original first line of the range for a multi-line comment. * @example 2 */ @@ -33099,9 +34294,9 @@ export interface components { * @description Data related to a release. */ "release-asset": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ browser_download_url: string; id: number; node_id: string; @@ -33110,6 +34305,7 @@ export interface components { * @example Team Environment */ name: string; + /** @nullable */ label: string | null; /** * @description State of the release asset. @@ -33119,9 +34315,9 @@ export interface components { content_type: string; size: number; download_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; uploader: components["schemas"]["nullable-simple-user"]; }; @@ -33130,16 +34326,22 @@ export interface components { * @description A release. */ release: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ assets_url: string; upload_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; id: number; node_id: string; @@ -33153,7 +34355,9 @@ export interface components { * @example master */ target_commitish: string; + /** @nullable */ name: string | null; + /** @nullable */ body?: string | null; /** * @description true to create a draft (unpublished) release, false to create a published one. @@ -33165,9 +34369,12 @@ export interface components { * @example false */ prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; author: components["schemas"]["simple-user"]; assets: components["schemas"]["release-asset"][]; @@ -33175,8 +34382,8 @@ export interface components { body_text?: string; mentions_count?: number; /** - * Format: uri * @description The URL of the release discussion. + * @format uri */ discussion_url?: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -33221,19 +34428,23 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; @@ -33244,22 +34455,33 @@ export interface components { secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; /** @@ -33267,12 +34489,21 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. + */ multi_repo?: boolean | null; }; - /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ + /** + * @nullable + * @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; /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ "secret-scanning-location-commit": { @@ -33343,99 +34574,99 @@ export interface components { /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_title_url: string; }; /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ "secret-scanning-location-issue-body": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_body_url: string; }; /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ "secret-scanning-location-issue-comment": { /** - * Format: uri * @description The API URL to get the issue comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ issue_comment_url: string; }; /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ "secret-scanning-location-discussion-title": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082 + * @format uri */ discussion_title_url: string; }; /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ "secret-scanning-location-discussion-body": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussion-4566270 + * @format uri */ discussion_body_url: string; }; /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ "secret-scanning-location-discussion-comment": { /** - * Format: uri * @description The API URL to get the discussion comment where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + * @format uri */ discussion_comment_url: string; }; /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ "secret-scanning-location-pull-request-title": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ pull_request_title_url: string; }; /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ "secret-scanning-location-pull-request-body": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ pull_request_body_url: string; }; /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ "secret-scanning-location-pull-request-comment": { /** - * Format: uri * @description The API URL to get the pull request comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ pull_request_comment_url: string; }; /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ "secret-scanning-location-pull-request-review": { /** - * Format: uri * @description The API URL to get the pull request review where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + * @format uri */ pull_request_review_url: string; }; /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ "secret-scanning-location-pull-request-review-comment": { /** - * Format: uri * @description The API URL to get the pull request review comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + * @format uri */ pull_request_review_comment_url: string; }; @@ -33456,8 +34687,9 @@ export interface components { "secret-scanning-push-protection-bypass": { reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** - * Format: date-time + * @nullable * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ expire_at?: string | null; /** @description The token type this bypass is for. */ @@ -33470,13 +34702,15 @@ export interface components { /** @description The state of the scan. Either "completed", "running", or "pending" */ status?: string; /** - * Format: date-time + * @nullable * @description The time that the scan was completed. Empty if the scan is running + * @format date-time */ completed_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the scan was started. Empty if the scan is pending + * @format date-time */ started_at?: string | null; }; @@ -33496,37 +34730,62 @@ export interface components { summary: string; /** @description A detailed description of what the advisory impacts. */ description: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ vulnerabilities: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ credits?: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33539,29 +34798,51 @@ export interface components { summary: string; /** @description A detailed description of what the advisory impacts. */ description: string; - /** @description An array of products affected by the vulnerability detailed in a repository security advisory. */ + /** + * @nullable + * @description An array of products affected by the vulnerability detailed in a repository security advisory. + */ vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[] | null; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33574,46 +34855,77 @@ export interface components { summary?: string; /** @description A detailed description of what the advisory impacts. */ description?: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ credits?: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description The state of the advisory. * @enum {string} */ state?: "published" | "closed" | "draft"; - /** @description A list of usernames who have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of usernames who have been granted write access to the advisory. + */ collaborating_users?: string[] | null; - /** @description A list of team slugs which have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of team slugs which have been granted write access to the advisory. + */ collaborating_teams?: string[] | null; }; /** @@ -33621,7 +34933,7 @@ export interface components { * @description Stargazer */ stargazer: { - /** Format: date-time */ + /** @format date-time */ starred_at: string; user: components["schemas"]["nullable-simple-user"]; }; @@ -33694,20 +35006,21 @@ export interface components { subscribed: boolean; /** @description Determines if all notifications should be blocked from this repository. */ ignored: boolean; + /** @nullable */ reason: string | null; /** - * Format: date-time * @example 2012-10-06T21:34:12Z + * @format date-time */ created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/subscription + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; }; @@ -33720,17 +35033,17 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** - * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 + * @format uri */ zipball_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 + * @format uri */ tarball_url: string; node_id: string; @@ -33760,7 +35073,7 @@ export interface components { }; /** Traffic */ traffic: { - /** Format: date-time */ + /** @format date-time */ timestamp: string; uniques: number; count: number; @@ -33816,6 +35129,7 @@ export interface components { /** Search Result Text Matches */ "search-result-text-matches": { object_url?: string; + /** @nullable */ object_type?: string | null; property?: string; fragment?: string; @@ -33832,17 +35146,18 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; repository: components["schemas"]["minimal-repository"]; score: number; file_size?: number; + /** @nullable */ language?: string | null; - /** Format: date-time */ + /** @format date-time */ last_modified_at?: string; /** * @example [ @@ -33858,18 +35173,18 @@ export interface components { * @description Commit Search Result Item */ "commit-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { name: string; email: string; - /** Format: date-time */ + /** @format date-time */ date: string; }; committer: components["schemas"]["nullable-git-user"]; @@ -33877,10 +35192,10 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification?: components["schemas"]["verification"]; }; @@ -33901,34 +35216,37 @@ export interface components { * @description Issue Search Result Item */ "issue-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; number: number; title: string; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; user: components["schemas"]["nullable-simple-user"]; labels: { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; url?: string; name?: string; color?: string; default?: boolean; + /** @nullable */ description?: string | null; }[]; /** Sub-issues Summary */ @@ -33938,27 +35256,46 @@ export interface components { percent_completed: number; }; state: string; + /** @nullable */ state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; milestone: components["schemas"]["nullable-milestone"]; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; body?: string; @@ -33968,7 +35305,7 @@ export interface components { repository?: components["schemas"]["repository"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -33980,11 +35317,12 @@ export interface components { "label-search-result-item": { id: number; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; name: string; color: string; default: boolean; + /** @nullable */ description: string | null; score: number; text_matches?: components["schemas"]["search-result-text-matches"]; @@ -34000,58 +35338,63 @@ export interface components { full_name: string; owner: components["schemas"]["nullable-simple-user"]; private: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; + /** @nullable */ description: string | null; fork: boolean; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ pushed_at: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ homepage: string | null; size: number; stargazers_count: number; watchers_count: number; + /** @nullable */ language: string | null; forks_count: number; open_issues_count: number; master_branch?: string; default_branch: string; score: number; - /** Format: uri */ + /** @format uri */ forks_url: string; keys_url: string; collaborators_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; issue_events_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; assignees_url: string; branches_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; blobs_url: string; git_tags_url: string; git_refs_url: string; trees_url: string; statuses_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; commits_url: string; git_commits_url: string; @@ -34059,10 +35402,10 @@ export interface components { issue_comment_url: string; contents_url: string; compare_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; archive_url: string; - /** Format: uri */ + /** @format uri */ downloads_url: string; issues_url: string; pulls_url: string; @@ -34070,18 +35413,21 @@ export interface components { notifications_url: string; labels_url: string; releases_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; git_url: string; ssh_url: string; clone_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; forks: number; open_issues: number; watchers: number; topics?: string[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; has_issues: boolean; has_projects: boolean; @@ -34120,22 +35466,32 @@ export interface components { */ "topic-search-result-item": { name: string; + /** @nullable */ display_name: string | null; + /** @nullable */ short_description: string | null; + /** @nullable */ description: string | null; + /** @nullable */ created_by: string | null; + /** @nullable */ released: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; featured: boolean; curated: boolean; score: number; + /** @nullable */ repository_count?: number | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ logo_url?: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ related?: { topic_relation?: { id?: number; @@ -34144,6 +35500,7 @@ export interface components { relation_type?: string; }; }[] | null; + /** @nullable */ aliases?: { topic_relation?: { id?: number; @@ -34159,25 +35516,26 @@ export interface components { */ "user-search-result-item": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; score: number; @@ -34189,21 +35547,33 @@ export interface components { public_gists?: number; followers?: number; following?: number; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; + /** @nullable */ name?: string | null; + /** @nullable */ bio?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; + /** @nullable */ location?: string | null; site_admin: boolean; + /** @nullable */ hireable?: boolean | null; text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ blog?: string | null; + /** @nullable */ company?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at?: string | null; user_view_type?: string; }; @@ -34215,8 +35585,8 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -34227,25 +35597,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -34255,52 +35628,73 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ type: string; site_admin: boolean; - /** @example monalisa octocat */ + /** + * @nullable + * @example monalisa octocat + */ name: string | null; - /** @example GitHub */ + /** + * @nullable + * @example GitHub + */ company: string | null; - /** @example https://github.com/blog */ + /** + * @nullable + * @example https://github.com/blog + */ blog: string | null; - /** @example San Francisco */ + /** + * @nullable + * @example San Francisco + */ location: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ email: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ notification_email?: string | null; + /** @nullable */ hireable: boolean | null; - /** @example There once was... */ + /** + * @nullable + * @example There once was... + */ bio: string | null; - /** @example monalisa */ + /** + * @nullable + * @example monalisa + */ twitter_username?: string | null; /** @example 2 */ public_repos: number; @@ -34311,13 +35705,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ updated_at: string; /** @example 81 */ @@ -34352,13 +35746,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -34367,9 +35761,9 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/user/secrets/SECRET_NAME/repositories + * @format uri */ selected_repositories_url: string; }; @@ -34395,22 +35789,26 @@ export interface components { */ "codespace-export-details": { /** + * @nullable * @description State of the latest export * @example succeeded | failed | in_progress */ state?: string | null; /** - * Format: date-time + * @nullable * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z + * @format date-time */ completed_at?: string | null; /** + * @nullable * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ branch?: string | null; /** + * @nullable * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ @@ -34426,6 +35824,7 @@ export interface components { */ export_url?: string; /** + * @nullable * @description Web url for the exported branch * @example https://github.com/octocat/hello-world/tree/:branch */ @@ -34437,8 +35836,8 @@ export interface components { */ "codespace-with-full-repository": { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -34447,11 +35846,13 @@ export interface components { */ name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -34461,29 +35862,31 @@ export interface components { repository: components["schemas"]["full-repository"]; machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ last_used_at: string; /** @@ -34493,8 +35896,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -34526,60 +35929,77 @@ export interface components { */ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ allowed_port_privacy_settings?: string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ retention_expires_at?: string | null; }; @@ -34589,15 +36009,18 @@ export interface components { */ email: { /** - * Format: email * @example octocat@github.com + * @format email */ email: string; /** @example true */ primary: boolean; /** @example true */ verified: boolean; - /** @example public */ + /** + * @nullable + * @example public + */ visibility: string | null; }; /** @@ -34606,12 +36029,16 @@ export interface components { */ "gpg-key": { /** - * Format: int64 * @example 3 + * @format int64 */ id: number; - /** @example Octocat's GPG Key */ + /** + * @nullable + * @example Octocat's GPG Key + */ name?: string | null; + /** @nullable */ primary_key_id: number | null; /** @example 3262EFF25BA0D270 */ key_id: string; @@ -34648,7 +36075,7 @@ export interface components { * ] */ subkeys: { - /** Format: int64 */ + /** @format int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -34663,7 +36090,9 @@ export interface components { can_encrypt_storage?: boolean; can_certify?: boolean; created_at?: string; + /** @nullable */ expires_at?: string | null; + /** @nullable */ raw_key?: string | null; revoked?: boolean; }[]; @@ -34674,14 +36103,18 @@ export interface components { /** @example true */ can_certify: boolean; /** - * Format: date-time * @example 2016-03-24T11:31:04-06:00 + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; /** @example true */ revoked: boolean; + /** @nullable */ raw_key: string | null; }; /** @@ -34690,26 +36123,32 @@ export interface components { */ key: { key: string; - /** Format: int64 */ + /** @format int64 */ id: number; url: string; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; verified: boolean; read_only: boolean; }; /** Marketplace Account */ "marketplace-account": { - /** Format: uri */ + /** @format uri */ url: string; id: number; type: string; node_id?: string; login: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ organization_billing_email?: string | null; }; /** @@ -34720,21 +36159,25 @@ export interface components { /** @example monthly */ billing_cycle: string; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ next_billing_date: string | null; + /** @nullable */ unit_count: number | null; /** @example true */ on_free_trial: boolean; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ free_trial_ends_on: string | null; /** - * Format: date-time + * @nullable * @example 2017-11-02T01:12:12Z + * @format date-time */ updated_at: string | null; account: components["schemas"]["marketplace-account"]; @@ -34758,7 +36201,7 @@ export interface components { key: string; id: number; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; }; /** @@ -34766,7 +36209,7 @@ export interface components { * @description Starred Repository */ "starred-repository": { - /** Format: date-time */ + /** @format date-time */ starred_at: string; repo: components["schemas"]["repository"]; }; @@ -34795,9 +36238,11 @@ export interface components { inclusionPromise?: { signedEntryTimestamp?: string; }; + /** @nullable */ inclusionProof?: string | null; canonicalizedBody?: string; }[]; + /** @nullable */ timestampVerificationData?: string | null; }; dsseEnvelope?: { @@ -34834,16 +36279,20 @@ export interface components { * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." */ "enterprise-webhooks": { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -34864,16 +36313,18 @@ export interface components { */ slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** @@ -34907,18 +36358,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -34931,7 +36382,10 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; }; /** @@ -34941,9 +36395,9 @@ export interface components { */ "repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -34972,16 +36426,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -35003,28 +36460,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -35046,13 +36503,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -35066,30 +36523,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -35097,25 +36554,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -35190,18 +36650,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -35210,6 +36673,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id?: number; node_id?: string; @@ -35456,7 +36920,7 @@ export interface components { authorized_actors_only: boolean; authorized_dismissal_actors_only: boolean; create_protected?: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; dismiss_stale_reviews_on_push: boolean; id: number; @@ -35490,24 +36954,34 @@ export interface components { /** @enum {string} */ signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; strict_required_status_checks_policy: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ after?: string | null; app?: components["schemas"]["integration"]; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ before?: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch?: string | null; /** * @description The SHA of the head commit that is being checked. @@ -35525,7 +36999,7 @@ export interface components { * @enum {string} */ status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ url?: string; @@ -35538,11 +37012,13 @@ export interface components { app: components["schemas"]["nullable-integration"]; check_suite: components["schemas"]["simple-check-suite"]; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ completed_at: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ @@ -35573,16 +37049,19 @@ export interface components { node_id: string; output: { annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; + /** @nullable */ summary: string | null; + /** @nullable */ text: string | null; + /** @nullable */ title: string | null; }; pull_requests: components["schemas"]["pull-request-minimal"][]; /** - * Format: date-time * @example 2018-05-04T01:14:52Z + * @format date-time */ started_at: string; /** @@ -35604,34 +37083,39 @@ export interface components { webhooks_ref_0: string; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ webhooks_deploy_key: { + /** @nullable */ added_by?: string | null; created_at: string; id: number; key: string; + /** @nullable */ last_used?: string | null; read_only: boolean; title: string; - /** Format: uri */ + /** @format uri */ url: string; verified: boolean; enabled?: boolean; }; - /** Workflow */ + /** + * Workflow + * @nullable + */ webhooks_workflow: { - /** Format: uri */ + /** @format uri */ badge_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; node_id: string; path: string; state: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; webhooks_approver: { @@ -35656,92 +37140,102 @@ export interface components { user_view_type?: string; }; webhooks_reviewers: { - /** User */ + /** + * User + * @nullable + */ reviewer?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @enum {string} */ type?: "User"; }[]; webhooks_workflow_job_run: { + /** @nullable */ conclusion: unknown; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: unknown; status: string; updated_at: string; }; - /** User */ + /** + * User + * @nullable + */ webhooks_user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35754,12 +37248,13 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; child_comment_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; discussion_id: number; html_url: string; id: number; node_id: string; + /** @nullable */ parent_id: unknown; /** Reactions */ reactions?: { @@ -35772,48 +37267,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35823,46 +37322,53 @@ export interface components { * @description A Discussion in a repository. */ discussion: { + /** @nullable */ active_lock_reason: string | null; + /** @nullable */ answer_chosen_at: string | null; - /** User */ + /** + * User + * @nullable + */ answer_chosen_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ answer_html_url: string | null; /** * AuthorAssociation @@ -35872,7 +37378,7 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; category: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -35885,7 +37391,7 @@ export interface components { updated_at: string; }; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; html_url: string; id: number; @@ -35903,7 +37409,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; @@ -35915,6 +37421,7 @@ export interface components { */ state: "open" | "closed" | "locked" | "converting" | "transferring"; /** + * @nullable * @description The reason for the current state * @example resolved * @enum {string|null} @@ -35922,44 +37429,48 @@ export interface components { state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; timeline_url?: string; title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35979,6 +37490,7 @@ export interface components { html_url: string; id: number; node_id: string; + /** @nullable */ parent_id: number | null; /** Reactions */ reactions: { @@ -35991,47 +37503,51 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36041,14 +37557,15 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }; @@ -36092,16 +37609,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: components["schemas"]["integration"]; @@ -36116,52 +37633,56 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36178,80 +37699,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ webhooks_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -36261,95 +37790,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36362,67 +37910,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36501,19 +38064,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -36527,10 +38096,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -36543,54 +38112,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36600,56 +38174,67 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36662,9 +38247,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -36672,80 +38257,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ webhooks_issue_2: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -36755,95 +38348,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36856,67 +38468,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36995,19 +38622,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -37021,10 +38654,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -37037,93 +38670,102 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** User */ + /** + * User + * @nullable + */ webhooks_user_mannequin: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -37133,11 +38775,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date: string | null; on_free_trial: boolean; plan: { @@ -37149,6 +38794,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -37160,11 +38806,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: unknown; + /** @nullable */ next_billing_date?: string | null; on_free_trial: boolean; plan: { @@ -37176,6 +38825,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -37187,25 +38837,32 @@ export interface components { */ webhooks_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -37219,12 +38876,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -37234,12 +38891,12 @@ export interface components { privacy?: "open" | "closed" | "secret"; /** @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -37260,14 +38917,15 @@ export interface components { }; /** * Repository + * @nullable * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -37296,16 +38954,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -37327,28 +38988,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -37370,13 +39031,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -37390,30 +39051,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -37421,25 +39082,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -37514,18 +39178,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -37534,6 +39201,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id?: number; node_id?: string; @@ -37771,56 +39439,67 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone_3: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -37833,9 +39512,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -37843,48 +39522,52 @@ export interface components { * @description The membership between the user and the organization. Not present when the action is `member_invited`. */ webhooks_membership: { - /** Format: uri */ + /** @format uri */ organization_url: string; role: string; state: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -37938,9 +39621,15 @@ export interface components { * @enum {string} */ repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ repositories: { full_name: string; /** @description Unique identifier of the repository */ @@ -37959,154 +39648,174 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** Project Card */ webhooks_project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project */ webhooks_project: { - /** @description Body of the project */ + /** + * @nullable + * @description Body of the project + */ body: string | null; - /** Format: uri */ + /** @format uri */ columns_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Name of the project */ name: string; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ owner_url: string; /** * @description State of the project; either 'open' or 'closed' * @enum {string} */ state: "open" | "closed"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project Column */ webhooks_project_column: { + /** @nullable */ after_id?: number | null; - /** Format: uri */ + /** @format uri */ cards_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The unique identifier of the project column */ id: number; /** @description Name of the project column */ name: string; node_id: string; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -38119,37 +39828,47 @@ export interface components { owner: components["schemas"]["simple-user"]; creator: components["schemas"]["simple-user"]; title: string; + /** @nullable */ description: string | null; public: boolean; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; number: number; + /** @nullable */ short_description: string | null; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ deleted_at: string | null; deleted_by: components["schemas"]["nullable-simple-user"]; }; webhooks_project_changes: { archived_at?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ from?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ to?: string | null; }; }; @@ -38171,18 +39890,19 @@ export interface components { content_type: components["schemas"]["projects-v2-item-content-type"]; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ archived_at: string | null; }; @@ -38193,7 +39913,9 @@ export interface components { "projects-v2-single-select-option": { id: string; name: string; + /** @nullable */ color?: string | null; + /** @nullable */ description?: string | null; }; /** @@ -38203,7 +39925,9 @@ export interface components { "projects-v2-iteration-setting": { id: string; title: string; + /** @nullable */ duration?: number | null; + /** @nullable */ start_date?: string | null; }; /** @@ -38216,28 +39940,32 @@ export interface components { project_node_id?: string; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** - * Format: date * @example 2022-04-28 + * @format date */ start_date?: string; /** - * Format: date * @example 2022-04-28 + * @format date */ target_date?: string; /** + * @nullable * @description Body of the status update * @example The project is off to a great start! */ @@ -38299,120 +40027,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -38423,48 +40159,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -38505,32 +40252,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -38540,28 +40287,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -38589,37 +40337,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -38640,55 +40396,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -38702,11 +40465,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -38729,26 +40494,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -38763,60 +40528,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -38851,32 +40624,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -38886,28 +40659,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -38935,37 +40709,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -38986,55 +40768,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39048,11 +40837,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -39075,26 +40866,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -39109,168 +40900,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -39283,73 +41101,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -39358,12 +41185,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -39371,36 +41198,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -39409,12 +41243,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -39422,69 +41256,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39497,17 +41335,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -39521,20 +41359,23 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; @@ -39544,17 +41385,26 @@ export interface components { original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -39568,7 +41418,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -39576,9 +41426,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -39589,49 +41443,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39641,12 +41499,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -39656,60 +41514,71 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; state: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ submitted_at: string | null; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ webhooks_nullable_string: string | null; /** * Release @@ -39717,13 +41586,14 @@ export interface components { */ webhooks_release: { assets: { - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -39734,103 +41604,119 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; }[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -39843,20 +41729,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; /** @@ -39865,13 +41757,14 @@ export interface components { */ webhooks_release_1: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -39882,103 +41775,119 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -39991,20 +41900,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; /** @@ -40017,48 +41932,55 @@ export interface components { created_at: string; dismiss_reason?: string; dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -40070,6 +41992,7 @@ export interface components { state: "open"; }; /** + * @nullable * @description The reason for resolving the alert. * @enum {string|null} */ @@ -40081,18 +42004,22 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; @@ -40106,33 +42033,51 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or business. + */ multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { cvss: { score: number; + /** @nullable */ vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -40148,13 +42093,14 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; summary: string; updated_at: string; vulnerabilities: { + /** @nullable */ first_patched_version: { identifier: string; } | null; @@ -40165,6 +42111,7 @@ export interface components { severity: string; vulnerable_version_range: string; }[]; + /** @nullable */ withdrawn_at: string | null; }; webhooks_sponsorship: { @@ -40192,79 +42139,87 @@ export interface components { }; node_id: string; privacy_level: string; - /** User */ + /** + * User + * @nullable + */ sponsor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** User */ + /** + * User + * @nullable + */ sponsorable: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40311,25 +42266,32 @@ export interface components { */ webhooks_team_1: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -40343,12 +42305,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -40361,12 +42323,12 @@ export interface components { * @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -40419,15 +42381,18 @@ export interface components { /** @description If the action was `edited`, the changes to the rule. */ changes?: { admin_enforced?: { + /** @nullable */ from: boolean | null; }; authorized_actor_names?: { from: string[]; }; authorized_actors_only?: { + /** @nullable */ from: boolean | null; }; authorized_dismissal_actors_only?: { + /** @nullable */ from: boolean | null; }; linear_history_requirement_enforcement_level?: { @@ -40439,6 +42404,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; lock_allows_fork_sync?: { + /** @nullable */ from: boolean | null; }; pull_request_reviews_enforcement_level?: { @@ -40446,6 +42412,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; require_last_push_approval?: { + /** @nullable */ from: boolean | null; }; required_status_checks?: { @@ -40546,63 +42513,81 @@ export interface components { action: "completed"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description The client ID of the GitHub app */ + /** + * @nullable + * @description The client ID of the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40681,20 +42666,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -40703,9 +42696,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40716,9 +42712,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40742,7 +42741,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -40753,28 +42752,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -40790,63 +42790,81 @@ export interface components { action: "requested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description Client ID of the GitHub app */ + /** + * @nullable + * @description Client ID of the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40925,20 +42943,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -40947,9 +42973,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40960,9 +42989,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40986,7 +43018,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -40997,28 +43029,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -41034,63 +43067,81 @@ export interface components { action: "rerequested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description The Client ID for the GitHub app */ + /** + * @nullable + * @description The Client ID for the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -41169,20 +43220,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -41191,9 +43250,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -41204,9 +43266,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -41230,7 +43295,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -41241,28 +43306,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -41279,67 +43345,79 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41375,12 +43453,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41388,10 +43468,13 @@ export interface components { tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41409,67 +43492,78 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41503,17 +43597,23 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** @@ -41522,13 +43622,17 @@ export interface components { */ state: "dismissed" | "fixed"; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41546,25 +43650,39 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time + * @nullable * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: unknown; + /** @nullable */ dismissed_by: unknown; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41598,33 +43716,46 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | null; + /** @nullable */ tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; } | null; + /** @nullable */ updated_at?: string | null; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41642,69 +43773,81 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41738,32 +43881,43 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "fixed" | null; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41778,27 +43932,43 @@ export interface components { "webhook-code-scanning-alert-reopened": { /** @enum {string} */ action: "reopened"; - /** @description The code scanning alert involved in the event. */ + /** + * @nullable + * @description The code scanning alert involved in the event. + */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: string | null; + /** @nullable */ dismissed_by: Record | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: string | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41832,40 +44002,57 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | "fixed" | null; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; } | null; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ commit_oid: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -41877,24 +44064,37 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: unknown; + /** @nullable */ dismissed_by: unknown; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41930,12 +44130,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41943,10 +44145,13 @@ export interface components { tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41977,17 +44182,26 @@ export interface components { /** @description The SHA of the commit to which the comment applies. */ commit_id: string; created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The ID of the commit comment. */ id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the commit comment. */ node_id: string; - /** @description The relative path of the file to which the comment applies. */ + /** + * @nullable + * @description The relative path of the file to which the comment applies. + */ path: string | null; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; /** Reactions */ reactions?: { @@ -42000,48 +44214,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42054,7 +44272,10 @@ export interface components { }; /** create event */ "webhook-create": { - /** @description The repository's current description. */ + /** + * @nullable + * @description The repository's current description. + */ description: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; @@ -42242,44 +44463,49 @@ export interface components { */ deployment: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; environment: string; id: number; @@ -42288,58 +44514,73 @@ export interface components { payload: Record | string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42418,20 +44659,23 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -42440,43 +44684,50 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42485,13 +44736,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: unknown; head_repository?: { archive_url?: string; @@ -42505,6 +44760,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -42561,7 +44817,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -42569,6 +44825,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: unknown; pull_requests: { base: { @@ -42577,7 +44834,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -42588,16 +44845,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -42615,6 +44873,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -42673,51 +44932,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -42732,8 +44995,8 @@ export interface components { /** @description The event that triggered the deployment protection rule. */ event?: string; /** - * Format: uri * @description The URL to review the deployment protection rule. + * @format uri */ deployment_callback_url?: string; deployment?: components["schemas"]["deployment"]; @@ -42757,52 +45020,61 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { + /** @nullable */ conclusion?: unknown; created_at?: string; environment?: string; html_url?: string; id?: number; + /** @nullable */ name?: string | null; status?: string; updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42811,13 +45083,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url?: string; @@ -42831,6 +45107,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -42888,7 +45165,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -42896,6 +45173,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -42904,7 +45182,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -42915,16 +45193,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -42942,6 +45221,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43001,51 +45281,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43065,52 +45349,61 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { + /** @nullable */ conclusion?: string | null; created_at?: string; environment?: string; html_url?: string; id?: number; + /** @nullable */ name?: string | null; status?: string; updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43119,12 +45412,16 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url?: string; @@ -43138,6 +45435,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43195,7 +45493,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -43203,6 +45501,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -43211,7 +45510,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -43222,16 +45521,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -43249,6 +45549,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43308,51 +45609,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43369,41 +45674,45 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; requestor: components["schemas"]["webhooks_user"]; reviewers: { - /** User */ + /** + * User + * @nullable + */ reviewer?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43413,52 +45722,61 @@ export interface components { sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { + /** @nullable */ conclusion: unknown; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: string | null; status: string; updated_at: string; }; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43467,12 +45785,16 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url?: string; @@ -43486,6 +45808,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43543,7 +45866,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -43551,6 +45874,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -43559,7 +45883,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -43570,16 +45894,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -43597,6 +45922,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43656,51 +45982,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43711,34 +46041,39 @@ export interface components { "webhook-deployment-status-created": { /** @enum {string} */ action: "created"; + /** @nullable */ check_run?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ completed_at: string | null; /** + * @nullable * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ + /** @format uri */ details_url: string; external_id: string; /** @description The SHA of the commit that is being checked. */ head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The id of the check. */ id: number; /** @description The name of the check run. */ name: string; node_id: string; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ + /** @format uri */ url: string; } | null; /** @@ -43747,104 +46082,125 @@ export interface components { */ deployment: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; environment: string; id: number; node_id: string; original_environment: string; + /** @nullable */ payload: (string | Record) | null; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43923,128 +46279,150 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ deployment_url: string; /** @description The optional human-readable description added to the status. */ description: string; environment: string; - /** Format: uri */ + /** @format uri */ environment_url?: string; id: number; - /** Format: uri */ + /** @format uri */ log_url?: string; node_id: string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44123,17 +46501,20 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; - /** Format: uri */ + /** @format uri */ repository_url: string; /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ state: string; /** @description The optional link added to the status. */ target_url: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -44142,43 +46523,50 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run?: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44187,13 +46575,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: unknown; head_repository?: { archive_url?: string; @@ -44207,6 +46599,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -44263,7 +46656,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -44271,6 +46664,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: unknown; pull_requests: { base: { @@ -44279,7 +46673,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -44290,16 +46684,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -44317,6 +46712,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -44375,51 +46771,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -44444,7 +46844,7 @@ export interface components { changes: { category: { from: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -44693,32 +47093,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -44728,28 +47128,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -44772,89 +47173,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44868,36 +47284,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -44922,6 +47340,7 @@ export interface components { created_at?: string; default_branch?: string; deployments_url?: string; + /** @nullable */ description?: string | null; disabled?: boolean; downloads_url?: string; @@ -44941,6 +47360,7 @@ export interface components { has_pages?: boolean; has_projects?: boolean; has_wiki?: boolean; + /** @nullable */ homepage?: string | null; hooks_url?: string; html_url?: string; @@ -44951,11 +47371,14 @@ export interface components { issues_url?: string; keys_url?: string; labels_url?: string; + /** @nullable */ language?: unknown; languages_url?: string; + /** @nullable */ license?: Record | null; merges_url?: string; milestones_url?: string; + /** @nullable */ mirror_url?: unknown; name?: string; node_id?: string; @@ -45029,14 +47452,15 @@ export interface components { */ action: "created" | "edited"; /** - * Format: uri * @description Points to the HTML wiki page. + * @format uri */ html_url: string; /** @description The name of the page. */ page_name: string; /** @description The latest commit SHA of the page. */ sha: string; + /** @nullable */ summary: string | null; /** @description The current page title. */ title: string; @@ -45065,6 +47489,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45077,6 +47502,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45137,14 +47563,17 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { + /** @nullable */ archived_at?: string | null; avatar_url: string; created_at?: string; + /** @nullable */ description?: unknown; events_url?: string; followers?: number; @@ -45177,6 +47606,7 @@ export interface components { type?: string; updated_at?: string; url?: string; + /** @nullable */ website_url?: unknown; user_view_type?: string; }; @@ -45206,6 +47636,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45226,16 +47657,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -45250,52 +47681,56 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45304,80 +47739,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -45387,95 +47830,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -45488,67 +47950,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45627,19 +48104,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -45653,10 +48136,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -45669,100 +48152,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -45774,22 +48269,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -45821,7 +48319,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -45848,80 +48346,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -45931,95 +48437,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -46032,67 +48557,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46171,19 +48711,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -46197,10 +48743,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -46213,100 +48759,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -46318,22 +48876,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -46365,7 +48926,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -46394,80 +48955,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -46477,95 +49046,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -46578,67 +49166,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46717,19 +49320,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -46743,10 +49352,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -46759,100 +49368,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -46864,22 +49485,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -46911,7 +49535,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -46955,80 +49579,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -47038,95 +49670,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -47139,67 +49790,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47278,19 +49944,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -47304,10 +49976,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -47320,63 +49992,72 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; + /** @nullable */ assignee?: Record | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at: string | null; comments?: number; comments_url?: string; @@ -47387,9 +50068,11 @@ export interface components { labels?: (Record | null)[]; labels_url?: string; locked?: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -47418,7 +50101,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -47448,80 +50131,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -47530,95 +50221,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -47631,67 +50341,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47770,19 +50495,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -47796,10 +50527,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -47812,54 +50543,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47879,79 +50615,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -47960,95 +50704,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48061,67 +50824,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48200,19 +50978,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -48226,10 +51010,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -48242,54 +51026,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48321,80 +51110,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -48403,95 +51200,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48504,67 +51320,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48643,19 +51474,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -48669,10 +51506,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -48685,54 +51522,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48753,80 +51595,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -48835,95 +51685,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48936,67 +51805,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49075,19 +51959,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49101,10 +51991,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49117,54 +52007,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49185,80 +52080,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -49268,96 +52171,115 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: true; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -49370,67 +52292,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49509,19 +52446,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49535,10 +52478,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49551,54 +52494,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49618,79 +52566,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -49699,95 +52655,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -49800,67 +52775,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49939,19 +52929,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49965,10 +52961,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49981,54 +52977,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50045,83 +53046,92 @@ export interface components { changes?: { /** * Issue + * @nullable * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ old_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50131,95 +53141,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50232,67 +53261,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50371,19 +53415,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -50397,10 +53447,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -50413,54 +53463,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50493,32 +53548,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -50532,28 +53587,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** @description Whether the repository has discussions enabled. */ has_discussions?: boolean; @@ -50578,89 +53634,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50674,36 +53745,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -50720,80 +53793,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50803,95 +53884,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50904,67 +54004,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51043,19 +54158,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51069,10 +54190,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51085,54 +54206,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51163,79 +54289,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -51244,95 +54378,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51345,67 +54498,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51484,19 +54652,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51510,10 +54684,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51526,54 +54700,59 @@ export interface components { * @enum {string} */ state: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51592,80 +54771,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ new_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -51675,95 +54862,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51776,67 +54982,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51915,19 +55136,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51941,10 +55168,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51957,54 +55184,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52037,32 +55269,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -52076,28 +55308,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -52125,89 +55358,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52221,36 +55469,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -52305,80 +55555,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -52388,96 +55646,115 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: false; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -52490,67 +55767,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52629,19 +55921,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -52655,10 +55953,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -52671,54 +55969,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52814,12 +56117,16 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date?: string | null; + /** @nullable */ on_free_trial: boolean | null; plan: { bullets: string[]; @@ -52830,6 +56137,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52853,11 +56161,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date?: string | null; on_free_trial: boolean; plan: { @@ -52869,6 +56180,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52890,11 +56202,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: unknown; + /** @nullable */ next_billing_date: string | null; on_free_trial: boolean; plan: { @@ -52906,6 +56221,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52967,7 +56283,9 @@ export interface components { from: string; }; permission?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; }; @@ -53003,41 +56321,45 @@ export interface components { * @enum {string} */ scope: "team"; - /** User */ + /** + * User + * @nullable + */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53057,41 +56379,45 @@ export interface components { * @enum {string} */ scope: "team" | "organization"; - /** User */ + /** + * User + * @nullable + */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53133,7 +56459,7 @@ export interface components { content_type: "json" | "form"; insecure_ssl: string; secret?: string; - /** Format: uri */ + /** @format uri */ url: string; }; created_at: string; @@ -53272,53 +56598,63 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ invitation: { - /** Format: date-time */ + /** @format date-time */ created_at: string; + /** @nullable */ email: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ failed_at: string | null; + /** @nullable */ failed_reason: string | null; id: number; - /** Format: uri */ + /** @format uri */ invitation_teams_url: string; - /** User */ + /** + * User + * @nullable + */ inviter: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ login: string | null; node_id: string; role: string; @@ -53385,96 +56721,110 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ package: { + /** @nullable */ created_at: string | null; + /** @nullable */ description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; package_type: string; + /** @nullable */ package_version: { - /** User */ + /** + * User + * @nullable + */ author?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; body?: string | Record; body_html?: string; + /** @nullable */ container_metadata?: { + /** @nullable */ labels?: Record | null; + /** @nullable */ manifest?: Record | null; tag?: { digest?: string; @@ -53487,7 +56837,7 @@ export interface components { tags?: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -53496,22 +56846,27 @@ export interface components { [key: string]: unknown; }[]; name: string; + /** @nullable */ npm_metadata?: { name?: string; version?: string; npm_user?: string; + /** @nullable */ author?: Record | null; + /** @nullable */ bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; + /** @nullable */ dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; + /** @nullable */ repository?: Record | null; scripts?: Record; id?: string; @@ -53525,6 +56880,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; + /** @nullable */ directories?: Record | null; os?: string[]; cpu?: string[]; @@ -53535,6 +56891,7 @@ export interface components { published_via_actions?: boolean; deleted_by_id?: number; } | null; + /** @nullable */ nuget_metadata?: { id?: number | string; name?: string; @@ -53548,69 +56905,78 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; + /** @nullable */ sha256: string | null; size: number; + /** @nullable */ state: string | null; updated_at: string; }[]; package_url?: string; prerelease?: boolean; release?: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; prerelease: boolean; published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; @@ -53622,15 +56988,17 @@ export interface components { updated_at?: string; version: string; } | null; + /** @nullable */ registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; + /** @nullable */ updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; @@ -53646,88 +57014,97 @@ export interface components { /** @description Information about the package. */ package: { created_at: string; + /** @nullable */ description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; package_type: string; package_version: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53739,7 +57116,7 @@ export interface components { tags?: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -53751,11 +57128,13 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; sha256: string; size: number; @@ -53765,47 +57144,51 @@ export interface components { package_url?: string; prerelease?: boolean; release?: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; @@ -53813,11 +57196,11 @@ export interface components { published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - /** Format: uri */ + /** @format uri */ source_url?: string; summary: string; tag_name?: string; @@ -53826,12 +57209,13 @@ export interface components { updated_at: string; version: string; }; + /** @nullable */ registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; @@ -53844,53 +57228,59 @@ export interface components { "webhook-page-build": { /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ build: { + /** @nullable */ commit: string | null; created_at: string; duration: number; error: { + /** @nullable */ message: string | null; }; - /** User */ + /** + * User + * @nullable + */ pusher: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; status: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -53956,9 +57346,9 @@ export interface components { secret?: components["schemas"]["webhook-config-secret"]; url?: components["schemas"]["webhook-config-url"]; }; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ deliveries_url?: string; /** @description Determines what events the hook is triggered for. Default: ['push']. */ events: string[]; @@ -53970,14 +57360,14 @@ export interface components { * @enum {string} */ name: "web"; - /** Format: uri */ + /** @format uri */ ping_url?: string; - /** Format: uri */ + /** @format uri */ test_url?: string; type: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** @description The ID of the webhook that triggered the ping. */ @@ -54029,63 +57419,70 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; + /** @nullable */ column_id: number | null; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; @@ -54097,6 +57494,7 @@ export interface components { action: "edited"; changes: { note: { + /** @nullable */ from: string | null; }; }; @@ -54120,70 +57518,78 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } & { + /** @nullable */ after_id: number | null; archived?: boolean; column_id?: number; column_url?: string; created_at?: string; + /** @nullable */ creator?: { avatar_url?: string; events_url?: string; @@ -54206,6 +57612,7 @@ export interface components { } | null; id?: number; node_id?: string; + /** @nullable */ note?: string | null; project_url?: string; updated_at?: string; @@ -54362,7 +57769,9 @@ export interface components { action: "edited"; changes: { description?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; public?: { @@ -54370,7 +57779,9 @@ export interface components { to?: boolean; }; short_description?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; title?: { @@ -54399,6 +57810,7 @@ export interface components { action: "converted"; changes: { content_type?: { + /** @nullable */ from?: string | null; to?: string; }; @@ -54440,12 +57852,16 @@ export interface components { field_type?: string; field_name?: string; project_number?: number; + /** @nullable */ from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + /** @nullable */ to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; }; } | { body: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; }; @@ -54460,7 +57876,9 @@ export interface components { action: "reordered"; changes: { previous_projects_v2_item_node_id?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; }; @@ -54512,25 +57930,45 @@ export interface components { action: "edited"; changes?: { body?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; status?: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; start_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ to?: string | null; }; target_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ to?: string | null; }; }; @@ -54561,120 +57999,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -54686,48 +58132,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54768,32 +58225,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -54803,28 +58260,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -54852,37 +58310,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -54903,55 +58369,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54965,11 +58438,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -54992,26 +58467,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55026,68 +58501,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -55114,32 +58599,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -55149,28 +58634,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -55198,37 +58684,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -55249,55 +58743,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55311,11 +58812,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -55338,26 +58841,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55372,168 +58875,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -55546,74 +59076,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -55622,12 +59161,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -55635,36 +59174,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -55673,12 +59219,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -55686,69 +59232,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55769,120 +59319,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -55893,48 +59451,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55975,32 +59544,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -56010,28 +59579,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -56059,37 +59629,45 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -56110,55 +59688,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56172,11 +59757,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -56199,26 +59786,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56233,60 +59820,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -56321,32 +59916,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -56356,28 +59951,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -56405,37 +60001,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -56456,55 +60060,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56518,11 +60129,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -56545,26 +60158,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56579,168 +60192,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -56753,74 +60393,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -56829,12 +60478,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -56842,36 +60491,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -56880,12 +60536,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -56893,69 +60549,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56977,120 +60637,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -57101,48 +60769,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57183,32 +60862,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -57218,28 +60897,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -57267,37 +60947,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -57318,55 +61006,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57380,11 +61075,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -57407,26 +61104,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57441,60 +61138,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -57529,32 +61234,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -57564,28 +61269,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -57613,34 +61319,42 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -57661,55 +61375,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57723,11 +61444,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -57750,26 +61473,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57784,168 +61507,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -57958,74 +61708,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -58034,12 +61793,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -58047,36 +61806,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -58085,12 +61851,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -58098,69 +61864,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58218,120 +61988,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -58342,48 +62120,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58424,32 +62213,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -58459,28 +62248,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -58508,37 +62298,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -58559,55 +62357,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58621,11 +62426,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -58648,26 +62455,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -58682,60 +62489,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -58770,32 +62585,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -58805,28 +62620,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -58854,37 +62670,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -58905,55 +62729,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58967,11 +62798,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -58994,26 +62827,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59028,168 +62861,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -59202,74 +63062,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59278,12 +63147,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59291,36 +63160,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59329,12 +63205,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59342,69 +63218,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59458,120 +63338,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -59582,48 +63470,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59664,32 +63563,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -59699,28 +63598,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -59748,37 +63648,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -59799,55 +63707,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59861,11 +63776,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -59888,26 +63805,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59922,60 +63839,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -60010,32 +63935,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60045,28 +63970,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60094,37 +64020,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -60145,55 +64079,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60207,11 +64148,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -60234,26 +64177,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -60268,168 +64211,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -60442,74 +64412,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -60518,12 +64497,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -60531,36 +64510,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -60569,12 +64555,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -60582,69 +64568,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60666,120 +64656,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -60790,48 +64788,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60872,32 +64881,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60907,28 +64916,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60956,37 +64966,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -61007,55 +65025,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61069,11 +65094,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -61096,26 +65123,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61130,68 +65157,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -61218,32 +65255,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -61253,28 +65290,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -61302,37 +65340,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -61353,55 +65399,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61415,11 +65468,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -61442,26 +65497,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61476,168 +65531,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -61650,74 +65732,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61726,12 +65817,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61739,36 +65830,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61777,12 +65875,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61790,69 +65888,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61873,120 +65975,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -61997,48 +66107,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62079,32 +66200,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -62114,28 +66235,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -62163,37 +66285,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -62214,55 +66344,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62276,11 +66413,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -62303,26 +66442,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62337,68 +66476,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -62425,32 +66574,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -62460,28 +66609,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -62509,37 +66659,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -62560,55 +66718,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62622,11 +66787,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -62649,26 +66816,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62683,168 +66850,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -62857,74 +67051,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62933,12 +67136,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62946,36 +67149,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62984,12 +67194,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62997,69 +67207,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63127,17 +67341,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -63151,40 +67365,55 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -63198,7 +67427,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -63206,9 +67435,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -63219,49 +67452,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63273,119 +67510,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -63396,48 +67641,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63478,32 +67734,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63513,28 +67769,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63562,37 +67819,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -63613,55 +67878,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63675,11 +67947,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -63702,26 +67976,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -63736,54 +68010,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -63791,6 +68071,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -63817,32 +68098,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63852,28 +68133,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63901,37 +68183,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -63952,55 +68242,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64014,11 +68311,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -64041,26 +68340,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64075,124 +68374,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -64205,72 +68523,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64279,12 +68605,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64292,36 +68618,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64330,12 +68663,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64343,63 +68676,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64419,119 +68756,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -64542,48 +68887,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64624,32 +68980,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -64659,28 +69015,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -64708,37 +69065,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -64759,55 +69124,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64821,11 +69193,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -64848,26 +69222,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64882,54 +69256,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -64937,6 +69317,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -64963,32 +69344,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -64998,28 +69379,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65047,37 +69429,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -65098,55 +69488,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65160,11 +69557,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -65187,26 +69586,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -65221,124 +69620,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -65351,72 +69769,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65425,12 +69851,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -65438,36 +69864,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65476,12 +69909,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -65489,63 +69922,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65566,119 +70003,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -65690,48 +70135,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65772,32 +70228,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -65807,28 +70263,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65856,37 +70313,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -65907,55 +70372,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65969,11 +70441,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -65996,26 +70470,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66030,54 +70504,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -66085,6 +70565,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -66111,32 +70592,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66146,28 +70627,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -66195,37 +70677,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -66246,55 +70736,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66308,11 +70805,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -66335,26 +70834,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66369,124 +70868,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -66499,72 +71017,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -66573,12 +71099,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -66586,36 +71112,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -66624,12 +71157,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -66637,64 +71170,68 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; user_view_type?: string; - /** Format: uri */ + /** @format uri */ url?: string; } | null; }; @@ -66713,119 +71250,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -66836,48 +71381,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66918,32 +71474,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66953,28 +71509,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -67002,37 +71559,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -67053,55 +71618,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67115,11 +71687,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -67142,26 +71716,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67176,54 +71750,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -67231,6 +71811,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -67257,32 +71838,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -67292,28 +71873,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -67341,37 +71923,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -67392,55 +71982,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67454,11 +72051,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -67481,26 +72080,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67515,124 +72114,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -67645,72 +72263,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67719,12 +72345,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67732,36 +72358,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67770,12 +72403,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67783,63 +72416,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67850,12 +72487,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -67865,57 +72502,64 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; /** @enum {string} */ state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ + /** @format date-time */ submitted_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67940,119 +72584,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -68063,48 +72715,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68145,32 +72808,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68180,28 +72843,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68224,89 +72888,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68320,36 +72999,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -68357,54 +73038,60 @@ export interface components { watchers_count: number; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -68412,6 +73099,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -68438,32 +73126,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68473,28 +73161,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68517,89 +73206,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68613,36 +73317,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -68650,124 +73356,143 @@ export interface components { watchers_count: number; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -68780,72 +73505,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68854,12 +73587,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68867,36 +73600,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68905,12 +73645,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68918,63 +73658,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68997,120 +73741,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -69122,48 +73874,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69204,32 +73967,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -69239,28 +74002,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -69288,37 +74052,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -69339,55 +74111,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69401,11 +74180,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -69421,26 +74202,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69455,60 +74236,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -69543,32 +74332,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -69578,28 +74367,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -69627,37 +74417,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -69678,55 +74476,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69740,11 +74545,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -69767,26 +74574,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69801,168 +74608,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -69975,74 +74809,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70051,12 +74894,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70064,36 +74907,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70102,12 +74952,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70115,109 +74965,117 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70235,120 +75093,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -70360,48 +75226,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70442,32 +75319,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70477,28 +75354,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70526,37 +75404,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -70577,55 +75463,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70639,11 +75532,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -70666,26 +75561,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -70700,60 +75595,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -70788,32 +75691,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70823,28 +75726,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70872,37 +75776,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -70923,55 +75835,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70985,11 +75904,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -71012,26 +75933,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71046,168 +75967,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -71220,74 +76168,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71296,12 +76253,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71309,36 +76266,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71347,12 +76311,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71360,69 +76324,73 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71434,25 +76402,32 @@ export interface components { */ requested_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71461,12 +76436,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71474,12 +76449,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }; @@ -71499,120 +76474,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -71624,48 +76607,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71706,32 +76700,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -71741,28 +76735,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -71790,37 +76785,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -71841,55 +76844,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71903,11 +76913,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -71930,26 +76942,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71964,60 +76976,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -72052,32 +77072,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72087,28 +77107,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -72136,37 +77157,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -72187,55 +77216,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72249,11 +77285,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -72276,26 +77314,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -72310,168 +77348,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -72484,74 +77549,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -72560,12 +77634,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -72573,36 +77647,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -72611,12 +77692,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -72624,109 +77705,117 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72744,120 +77833,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -72869,48 +77966,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72951,32 +78059,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72986,28 +78094,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73035,37 +78144,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -73086,55 +78203,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73148,11 +78272,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -73175,26 +78301,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73209,60 +78335,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -73297,32 +78431,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -73332,28 +78466,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73381,37 +78516,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -73432,55 +78575,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73494,11 +78644,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -73521,26 +78673,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73555,168 +78707,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -73729,74 +78908,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73805,12 +78993,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73818,36 +79006,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73856,12 +79051,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73869,69 +79064,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73943,25 +79142,32 @@ export interface components { */ requested_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73970,12 +79176,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73983,12 +79189,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -74006,119 +79212,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -74129,48 +79343,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74211,32 +79436,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -74246,28 +79471,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -74295,37 +79521,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -74346,55 +79580,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74408,11 +79649,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -74435,26 +79678,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74469,61 +79712,69 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -74550,32 +79801,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -74585,28 +79836,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -74634,37 +79886,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -74685,55 +79945,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74747,11 +80014,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -74774,26 +80043,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74808,124 +80077,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -74938,72 +80226,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75012,12 +80308,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75025,36 +80321,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75063,12 +80366,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75076,63 +80379,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75153,119 +80460,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -75276,48 +80591,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75358,32 +80684,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75393,28 +80719,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -75442,89 +80769,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75538,36 +80880,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -75577,61 +80921,69 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -75658,32 +81010,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75693,28 +81045,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -75742,89 +81095,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75838,36 +81206,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -75877,124 +81247,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -76007,72 +81396,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76081,12 +81478,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76094,36 +81491,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76132,12 +81536,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76145,63 +81549,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76213,17 +81621,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -76237,40 +81645,55 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -76284,7 +81707,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -76292,9 +81715,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -76305,49 +81732,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76367,119 +81798,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -76490,48 +81929,56 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; /** @description Title for the merge commit message. */ commit_title: string; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76572,32 +82019,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -76607,28 +82054,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76656,89 +82104,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76752,36 +82215,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -76791,54 +82256,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -76872,32 +82343,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -76907,28 +82378,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76956,89 +82428,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77052,36 +82539,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -77091,124 +82580,143 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -77221,72 +82729,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -77295,12 +82811,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -77308,36 +82824,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -77346,12 +82869,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -77359,63 +82882,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77427,17 +82954,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -77451,20 +82978,23 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; @@ -77474,17 +83004,26 @@ export interface components { original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -77498,7 +83037,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -77506,9 +83045,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -77519,49 +83062,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77584,120 +83131,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -77708,48 +83263,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77790,32 +83356,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -77825,28 +83391,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -77874,37 +83441,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -77925,55 +83500,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77987,11 +83569,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -78014,26 +83598,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78048,60 +83632,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -78136,32 +83728,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -78171,28 +83763,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -78220,37 +83813,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -78264,55 +83865,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78326,11 +83934,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -78353,26 +83963,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78387,168 +83997,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -78561,74 +84198,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78637,12 +84283,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78650,36 +84296,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78688,12 +84341,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78701,69 +84354,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78785,120 +84442,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -78909,48 +84574,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78961,6 +84637,7 @@ export interface components { merge_method: "merge" | "squash" | "rebase"; } | null; base: { + /** @nullable */ label: string | null; ref: string; /** @@ -78991,32 +84668,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79026,28 +84703,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79075,37 +84753,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -79126,55 +84812,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79188,11 +84881,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -79215,26 +84910,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79249,68 +84944,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -79337,32 +85042,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79372,28 +85077,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79421,37 +85127,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -79472,55 +85186,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79534,11 +85255,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -79561,26 +85284,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79595,168 +85318,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -79769,74 +85519,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79845,12 +85604,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79858,36 +85617,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79896,12 +85662,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79909,69 +85675,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79993,120 +85763,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -80117,48 +85895,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80199,32 +85988,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -80234,28 +86023,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -80283,37 +86073,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -80334,55 +86132,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80396,11 +86201,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -80423,26 +86230,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80457,68 +86264,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -80545,32 +86362,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -80580,28 +86397,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -80629,37 +86447,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -80673,55 +86499,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80735,11 +86568,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -80762,26 +86597,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80796,168 +86631,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -80970,74 +86832,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81046,12 +86917,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81059,36 +86930,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81097,12 +86975,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81110,69 +86988,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81193,120 +87075,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -81317,48 +87207,56 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; /** @description Title for the merge commit message. */ commit_title: string; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81399,32 +87297,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -81434,28 +87332,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -81483,37 +87382,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -81534,55 +87441,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81596,11 +87510,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -81623,26 +87539,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -81657,60 +87573,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -81719,6 +87643,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -81745,32 +87670,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -81780,28 +87705,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -81829,37 +87755,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -81880,55 +87814,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81942,11 +87883,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -81969,26 +87912,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -82003,168 +87946,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -82177,74 +88147,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82253,12 +88232,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82266,36 +88245,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82304,12 +88290,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82317,69 +88303,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82403,9 +88393,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82416,9 +88409,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82434,14 +88430,14 @@ export interface components { /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; }[]; @@ -82454,7 +88450,10 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ forced: boolean; - /** Commit */ + /** + * Commit + * @nullable + */ head_commit: { /** @description An array of files added in the commit. */ added?: string[]; @@ -82463,9 +88462,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82476,9 +88478,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82494,14 +88499,14 @@ export interface components { /** @description An array of files removed in the commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; } | null; @@ -82512,9 +88517,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ pusher: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; /** @description The git author's name. */ name: string; @@ -82550,32 +88558,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -82589,28 +88597,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -82638,89 +88647,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82734,36 +88758,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -82781,7 +88807,9 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { + /** @nullable */ created_at: string | null; + /** @nullable */ description: string | null; ecosystem: string; html_url: string; @@ -82810,6 +88838,7 @@ export interface components { user_view_type?: string; }; package_type: string; + /** @nullable */ package_version: { author?: { avatar_url: string; @@ -82835,7 +88864,9 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { + /** @nullable */ labels?: Record | null; + /** @nullable */ manifest?: Record | null; tag?: { digest?: string; @@ -82856,22 +88887,27 @@ export interface components { [key: string]: unknown; }[]; name: string; + /** @nullable */ npm_metadata?: { name?: string; version?: string; npm_user?: string; + /** @nullable */ author?: (string | Record) | null; + /** @nullable */ bugs?: (string | Record) | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; + /** @nullable */ dist?: (string | Record) | null; git_head?: string; homepage?: string; license?: string; main?: string; + /** @nullable */ repository?: (string | Record) | null; scripts?: Record; id?: string; @@ -82885,6 +88921,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; + /** @nullable */ directories?: (string | Record) | null; os?: string[]; cpu?: string[]; @@ -82895,7 +88932,9 @@ export interface components { published_via_actions?: boolean; deleted_by_id?: number; } | null; + /** @nullable */ nuget_metadata?: { + /** @nullable */ id?: (string | Record | number) | null; name?: string; value?: boolean | string | number | { @@ -82910,11 +88949,15 @@ export interface components { created_at: string; download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; + /** @nullable */ sha256: string | null; size: number; + /** @nullable */ state: string | null; updated_at: string; }[]; @@ -82946,6 +88989,7 @@ export interface components { draft?: boolean; html_url?: string; id?: number; + /** @nullable */ name?: string | null; prerelease?: boolean; published_at?: string; @@ -82961,6 +89005,7 @@ export interface components { updated_at?: string; version: string; } | null; + /** @nullable */ registry: { about_url?: string; name?: string; @@ -82968,6 +89013,7 @@ export interface components { url?: string; vendor?: string; } | null; + /** @nullable */ updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; @@ -82981,6 +89027,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { created_at: string; + /** @nullable */ description: unknown; ecosystem: string; html_url: string; @@ -83052,8 +89099,10 @@ export interface components { created_at?: string; download_url?: string; id?: number; + /** @nullable */ md5?: string | null; name?: string; + /** @nullable */ sha1?: string | null; sha256?: string; size?: number; @@ -83103,6 +89152,7 @@ export interface components { updated_at: string; version: string; }; + /** @nullable */ registry: Record | null; updated_at: string; }; @@ -83169,13 +89219,14 @@ export interface components { */ release: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -83186,98 +89237,111 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @@ -83285,7 +89349,10 @@ export interface components { * @enum {boolean} */ prerelease: true; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -83298,20 +89365,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -83407,7 +89480,10 @@ export interface components { /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ action: string; branch: string; - /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + /** + * @nullable + * @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + */ client_payload: { [key: string]: unknown; } | null; @@ -83426,12 +89502,15 @@ export interface components { from: string; }; description?: { + /** @nullable */ from: string | null; }; homepage?: { + /** @nullable */ from: string | null; }; topics?: { + /** @nullable */ from?: string[] | null; }; }; @@ -83577,65 +89656,70 @@ export interface components { from: { /** Organization */ organization?: { - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; - /** Format: uri */ + /** @format uri */ issues_url: string; login: string; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ public_members_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** User */ + /** + * User + * @nullable + */ user?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -83681,52 +89765,60 @@ export interface components { affected_package_name: string; affected_range: string; created_at: string; + /** @nullable */ dismiss_comment?: string | null; dismiss_reason: string; dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ dismisser: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -83768,48 +89860,55 @@ export interface components { created_at: string; dismiss_reason?: string; dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -83912,20 +90011,27 @@ export interface components { */ source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at: string; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at: string; - /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + /** + * @nullable + * @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates + */ secret_types?: string[] | null; - /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + /** + * @nullable + * @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated + */ custom_pattern_name?: string | null; /** + * @nullable * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated * @enum {string|null} */ @@ -83970,6 +90076,7 @@ export interface components { security_advisory: { cvss: { score: number; + /** @nullable */ vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -83985,13 +90092,14 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; summary: string; updated_at: string; vulnerabilities: { + /** @nullable */ first_patched_version: { identifier: string; } | null; @@ -84104,7 +90212,10 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ starred_at: string | null; }; /** star deleted event */ @@ -84116,68 +90227,85 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ starred_at: unknown; }; /** status event */ "webhook-status": { - /** Format: uri */ + /** + * @nullable + * @format uri + */ avatar_url?: string | null; /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */ branches: { commit: { + /** @nullable */ sha: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; name: string; protected: boolean; }[]; commit: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id?: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -84189,9 +90317,12 @@ export interface components { }; comment_count: number; committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -84204,74 +90335,84 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification: { + /** @nullable */ payload: string | null; /** @enum {string} */ reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; + /** @nullable */ signature: string | null; verified: boolean; + /** @nullable */ verified_at?: string | null; }; }; - /** User */ + /** + * User + * @nullable + */ committer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id?: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; node_id: string; parents: { - /** Format: uri */ + /** @format uri */ html_url: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }[]; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; context: string; created_at: string; - /** @description The optional human-readable description added to the status. */ + /** + * @nullable + * @description The optional human-readable description added to the status. + */ description: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ @@ -84288,7 +90429,10 @@ export interface components { * @enum {string} */ state: "pending" | "success" | "failure" | "error"; - /** @description The optional link added to the status. */ + /** + * @nullable + * @description The optional link added to the status. + */ target_url: string | null; updated_at: string; }; @@ -84400,32 +90544,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84439,28 +90583,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84483,89 +90628,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84579,36 +90739,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -84653,32 +90815,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84692,28 +90854,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84736,89 +90899,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84832,36 +91010,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -84906,32 +91086,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84945,28 +91125,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84989,89 +91170,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85085,36 +91281,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85190,32 +91388,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85229,28 +91427,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -85273,89 +91472,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85369,36 +91583,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85443,32 +91659,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85482,28 +91698,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -85526,89 +91743,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85622,36 +91854,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85674,6 +91908,7 @@ export interface components { /** workflow_dispatch event */ "webhook-workflow-dispatch": { enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @nullable */ inputs: { [key: string]: unknown; } | null; @@ -85694,15 +91929,19 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85711,15 +91950,27 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_name: string | null; started_at: string; /** @@ -85727,21 +91978,32 @@ export interface components { * @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "queued"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; @@ -85759,15 +92021,25 @@ export interface components { run_attempt?: number; run_id?: number; run_url?: string; + /** @nullable */ runner_group_id?: number | null; + /** @nullable */ runner_group_name?: string | null; + /** @nullable */ runner_id?: number | null; + /** @nullable */ runner_name?: string | null; started_at?: string; status?: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name?: string | null; steps?: (Record | null)[]; url?: string; @@ -85784,15 +92056,19 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | null | "cancelled" | "neutral"; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85801,15 +92077,27 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_name: string | null; started_at: string; /** @@ -85817,25 +92105,38 @@ export interface components { * @enum {string} */ status: "queued" | "in_progress" | "completed"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | null | "cancelled"; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; + /** @nullable */ completed_at?: string | null; + /** @nullable */ conclusion?: string | null; /** @description The time that the job created. */ created_at?: string; @@ -85848,22 +92149,35 @@ export interface components { run_attempt?: number; run_id?: number; run_url?: string; + /** @nullable */ runner_group_id?: number | null; + /** @nullable */ runner_group_name?: string | null; + /** @nullable */ runner_id?: number | null; + /** @nullable */ runner_name?: string | null; started_at?: string; /** @enum {string} */ status: "in_progress" | "completed" | "queued"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name?: string | null; steps: { + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "pending" | "queued"; @@ -85882,14 +92196,16 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -85897,31 +92213,46 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; + /** @nullable */ runner_group_id: number | null; + /** @nullable */ runner_group_name: string | null; + /** @nullable */ runner_id: number | null; + /** @nullable */ runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -85936,14 +92267,16 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -85951,31 +92284,46 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; + /** @nullable */ runner_group_id: number | null; + /** @nullable */ runner_group_name: string | null; + /** @nullable */ runner_id: number | null; + /** @nullable */ runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; /** @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -85992,57 +92340,65 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86051,9 +92407,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86064,9 +92423,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86079,143 +92441,152 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -86224,7 +92595,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -86235,16 +92606,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -86252,183 +92624,192 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. @@ -86449,56 +92830,64 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86507,9 +92896,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86520,9 +92912,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86535,142 +92930,154 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** @description The name of the repository. */ + /** + * @nullable + * @description The name of the repository. + */ name: string | null; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -86679,7 +93086,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -86690,16 +93097,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -86707,181 +93115,190 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; }; }; @@ -86897,57 +93314,65 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86956,9 +93381,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86969,9 +93397,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86984,143 +93415,152 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: { base: { @@ -87129,7 +93569,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -87140,16 +93580,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -87157,183 +93598,192 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; display_title: string; }; @@ -87450,6 +93900,7 @@ export interface components { block?: { reason?: string; created_at?: string; + /** @nullable */ html_url?: string | null; }; message?: string; @@ -89264,6 +95715,7 @@ export interface operations { "application/json": components["schemas"]["integration"] & ({ client_id: string; client_secret: string; + /** @nullable */ webhook_secret: string | null; pem: string; } & { @@ -90851,7 +97303,10 @@ export interface operations { [key: string]: { /** @description The new content of the file. */ content?: string; - /** @description The new filename for the file. */ + /** + * @nullable + * @description The new filename for the file. + */ filename?: string | null; } | null; }; @@ -91787,8 +98242,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at?: string; /** @description Whether the notification has been read. */ @@ -92386,7 +98841,10 @@ export interface operations { * @enum {string} */ source?: "github" | "partner" | "custom"; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ version?: string | null; }; /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ @@ -92613,7 +99071,10 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ image_version?: string | null; }; }; @@ -93103,7 +99564,10 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; - /** @description The identifier of a hosted compute network configuration. */ + /** + * @nullable + * @description The identifier of a hosted compute network configuration. + */ network_configuration_id?: string | null; }; }; @@ -93769,7 +100233,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -95210,7 +101677,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; @@ -95904,7 +102374,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -98453,7 +104926,10 @@ export interface operations { * @enum {string} */ action: "approve" | "deny"; - /** @description Reason for approving or denying the requests. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the requests. Max 1024 characters. + */ reason?: string | null; }; }; @@ -98486,7 +104962,10 @@ export interface operations { * @enum {string} */ action: "approve" | "deny"; - /** @description Reason for approving or denying the request. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the request. Max 1024 characters. + */ reason?: string | null; }; }; @@ -98728,9 +105207,15 @@ export interface operations { * @enum {string} */ registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ key_id: string; @@ -98865,9 +105350,15 @@ export interface operations { * @enum {string} */ registry_type?: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; @@ -100389,7 +106880,10 @@ export interface operations { * @enum {string} */ permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ parent_team_id?: number | null; }; }; @@ -101574,6 +108068,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -101619,6 +108114,7 @@ export interface operations { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom + * @pattern ^(?:top|bottom|after:\d+)$ */ position: string; /** @@ -101814,6 +108310,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -101889,6 +108386,7 @@ export interface operations { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last + * @pattern ^(?:first|last|after:\d+)$ */ position: string; }; @@ -101993,6 +108491,7 @@ export interface operations { */ name?: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -102374,6 +108873,7 @@ export interface operations { */ visibility?: "public" | "private"; /** + * @nullable * @description Specify which security and analysis features to enable or disable for the repository. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -104292,7 +110792,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -105251,7 +111754,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Require status checks to pass before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require status checks to pass before merging. Set to `null` to disable. + */ required_status_checks: { /** @description Require branches to be up to date before merging. */ strict: boolean; @@ -105268,9 +111774,15 @@ export interface operations { app_id?: number; }[]; } | null; - /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ + /** + * @nullable + * @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ enforce_admins: boolean | null; - /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ required_pull_request_reviews: { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { @@ -105302,7 +111814,10 @@ export interface operations { apps?: string[]; }; } | null; - /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ + /** + * @nullable + * @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ restrictions: { /** @description The list of user `login`s with push access */ users: string[]; @@ -105313,7 +111828,10 @@ export interface operations { } | null; /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ required_linear_history?: boolean; - /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + /** + * @nullable + * @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ allow_force_pushes?: boolean | null; /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ allow_deletions?: boolean; @@ -106409,8 +112927,8 @@ export interface operations { */ status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** - * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @@ -106420,8 +112938,8 @@ export interface operations { */ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -106551,8 +113069,8 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ external_id?: string; /** - * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @@ -106567,8 +113085,8 @@ export interface operations { */ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -107587,15 +114105,15 @@ export interface operations { ref: components["schemas"]["code-scanning-ref-full"]; sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** - * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ + * @format uri */ checkout_uri?: string; /** - * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ @@ -107954,6 +114472,7 @@ export interface operations { billable_owner?: components["schemas"]["simple-user"]; defaults?: { location: string; + /** @nullable */ devcontainer_path: string | null; }; }; @@ -108102,7 +114621,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -109497,7 +116019,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -109724,6 +116249,7 @@ export interface operations { */ environment?: string; /** + * @nullable * @description Short description of the deployment. * @default */ @@ -110073,7 +116599,10 @@ export interface operations { "application/json": { wait_timer?: components["schemas"]["wait-timer"]; prevent_self_review?: components["schemas"]["prevent-self-review"]; - /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ + /** + * @nullable + * @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + */ reviewers?: { type?: components["schemas"]["deployment-reviewer-type"]; /** @@ -110579,7 +117108,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -111009,8 +117541,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -111021,8 +117553,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email?: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -111286,8 +117818,8 @@ export interface operations { /** @description The email of the author of the tag */ email: string; /** - * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -111368,6 +117900,7 @@ export interface operations { */ type?: "blob" | "tree" | "commit"; /** + * @nullable * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. @@ -112391,14 +118924,20 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ + /** + * @nullable + * @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ + */ assignee?: string | null; + /** @nullable */ milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ labels?: (string | { id?: number; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ @@ -112772,11 +119311,20 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The title of the issue. */ + /** + * @nullable + * @description The title of the issue. + */ title?: (string | number) | null; - /** @description The contents of the issue. */ + /** + * @nullable + * @description The contents of the issue. + */ body?: string | null; - /** @description Username to assign to this issue. **This field is closing down.** */ + /** + * @nullable + * @description Username to assign to this issue. **This field is closing down.** + */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -112784,17 +119332,21 @@ export interface operations { */ state?: "open" | "closed"; /** + * @nullable * @description The reason for the state change. Ignored unless `state` is changed. * @example not_planned * @enum {string|null} */ state_reason?: "completed" | "not_planned" | "reopened" | null; + /** @nullable */ milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ labels?: (string | { id?: number; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ @@ -114100,8 +120652,8 @@ export interface operations { /** @description A description of the milestone. */ description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on?: string; }; @@ -114205,8 +120757,8 @@ export interface operations { /** @description A description of the milestone. */ description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on?: string; }; @@ -114312,8 +120864,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at?: string; }; @@ -114382,7 +120934,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ + /** + * @nullable + * @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." + */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -115008,9 +121563,9 @@ export interface operations { /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ head: string; /** - * Format: repo.nwo * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. * @example octo-org/octo-repo + * @format repo.nwo */ head_repo?: string; /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ @@ -115022,9 +121577,9 @@ export interface operations { /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ draft?: boolean; /** - * Format: int64 * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. * @example 1 + * @format int64 */ issue?: number; }; @@ -117871,12 +124426,16 @@ export interface operations { */ state: "error" | "failure" | "pending" | "success"; /** + * @nullable * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; - /** @description A short description of the status. */ + /** + * @nullable + * @description A short description of the status. + */ description?: string | null; /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. @@ -118942,7 +125501,10 @@ export interface operations { * @enum {string} */ permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ parent_team_id?: number | null; }; }; @@ -120026,6 +126588,7 @@ export interface operations { */ blog?: string; /** + * @nullable * @description The new Twitter username of the user. * @example therealomarj */ @@ -120385,7 +126948,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -121516,7 +128082,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. */ + /** + * @description The public SSH key to add to your GitHub account. + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) + */ key: string; }; }; @@ -122255,6 +128824,7 @@ export interface operations { */ name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -122747,7 +129317,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** + * @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com + */ key: string; }; }; diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index c63dd71bc..76f9cbf9a 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -18417,74 +18417,74 @@ export type webhooks = Record; export interface components { schemas: { root: { - /** Format: uri-template */ + /** @format uri-template */ current_user_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_authorizations_html_url: string; - /** Format: uri-template */ + /** @format uri-template */ authorizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ code_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ commit_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ emails_url: string; - /** Format: uri-template */ + /** @format uri-template */ emojis_url: string; - /** Format: uri-template */ + /** @format uri-template */ events_url: string; - /** Format: uri-template */ + /** @format uri-template */ feeds_url: string; - /** Format: uri-template */ + /** @format uri-template */ followers_url: string; - /** Format: uri-template */ + /** @format uri-template */ following_url: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url: string; /** - * Format: uri-template * @deprecated + * @format uri-template */ hub_url?: string; - /** Format: uri-template */ + /** @format uri-template */ issue_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ label_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ organization_teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ public_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ rate_limit_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_url: string; - /** Format: uri-template */ + /** @format uri-template */ repository_search_url: string; - /** Format: uri-template */ + /** @format uri-template */ current_user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_url: string; - /** Format: uri-template */ + /** @format uri-template */ starred_gists_url: string; - /** Format: uri-template */ + /** @format uri-template */ topic_search_url?: string; - /** Format: uri-template */ + /** @format uri-template */ user_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_organizations_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_repositories_url: string; - /** Format: uri-template */ + /** @format uri-template */ user_search_url: string; }; /** @@ -18494,34 +18494,67 @@ export interface components { "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ vulnerability: { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range: string | null; - /** @description The package version that resolves the vulnerability. */ + /** + * @nullable + * @description The package version that resolves the vulnerability. + */ first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ + /** + * @nullable + * @description The functions in the package that are affected by the vulnerability. + */ readonly vulnerable_functions: string[] | null; }; + /** @nullable */ "cvss-severities": { + /** @nullable */ cvss_v3?: { - /** @description The CVSS 3 vector string. */ + /** + * @nullable + * @description The CVSS 3 vector string. + */ vector_string: string | null; - /** @description The CVSS 3 score. */ + /** + * @nullable + * @description The CVSS 3 score. + */ readonly score: number | null; } | null; + /** @nullable */ cvss_v4?: { - /** @description The CVSS 4 vector string. */ + /** + * @nullable + * @description The CVSS 4 vector string. + */ vector_string: string | null; - /** @description The CVSS 4 score. */ + /** + * @nullable + * @description The CVSS 4 score. + */ readonly score: number | null; } | null; } | null; - /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + /** + * @nullable + * @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). + */ "security-advisory-epss": { percentage?: number; percentile?: number; @@ -18531,37 +18564,42 @@ export interface components { * @description A GitHub user. */ "simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -18571,25 +18609,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -18609,23 +18647,30 @@ export interface components { "global-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ readonly cve_id: string | null; /** @description The API URL for the advisory. */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** - * Format: uri + * @nullable * @description The API URL for the repository advisory. + * @format uri */ readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ description: string | null; /** * @description The type of advisory. @@ -18638,10 +18683,12 @@ export interface components { */ severity: "critical" | "high" | "medium" | "low" | "unknown"; /** - * Format: uri + * @nullable * @description The URL of the advisory's source code. + * @format uri */ source_code_location: string | null; + /** @nullable */ readonly identifiers: { /** * @description The type of identifier. @@ -18651,50 +18698,68 @@ export interface components { /** @description The identifier value. */ value: string; }[] | null; + /** @nullable */ references: string[] | null; /** - * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + * @format date-time */ readonly github_reviewed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. * This field is only populated when the advisory is imported from the National Vulnerability Database. + * @format date-time */ readonly nvd_published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; - /** @description The products and respective version ranges affected by the advisory. */ + /** + * @nullable + * @description The products and respective version ranges affected by the advisory. + */ vulnerabilities: components["schemas"]["vulnerability"][] | null; + /** @nullable */ cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; epss?: components["schemas"]["security-advisory-epss"]; + /** @nullable */ cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description The users who contributed to the advisory. */ + /** + * @nullable + * @description The users who contributed to the advisory. + */ readonly credits: { user: components["schemas"]["simple-user"]; type: components["schemas"]["security-advisory-credit-types"]; @@ -18724,16 +18789,20 @@ export interface components { * @description An enterprise on GitHub. */ enterprise: { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -18754,20 +18823,23 @@ export interface components { */ slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ integration: { @@ -18791,26 +18863,29 @@ export interface components { * @example Probot Owners */ name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ updated_at: string; /** @@ -18844,15 +18919,18 @@ export interface components { installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; } | null; /** - * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook + * @format uri */ "webhook-config-url": string; /** @@ -18892,9 +18970,9 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z + * @format date-time */ delivered_at: string; /** @@ -18923,24 +19001,28 @@ export interface components { */ event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ throttled_at?: string | null; }; @@ -18949,10 +19031,14 @@ export interface components { * @description Scim Error */ "scim-error": { + /** @nullable */ message?: string | null; + /** @nullable */ documentation_url?: string | null; + /** @nullable */ detail?: string | null; status?: number; + /** @nullable */ scimType?: string | null; schemas?: string[]; }; @@ -18988,9 +19074,9 @@ export interface components { */ guid: string; /** - * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z + * @format date-time */ delivered_at: string; /** @@ -19019,24 +19105,28 @@ export interface components { */ event: string; /** + * @nullable * @description The type of activity for the event that triggered the delivery. * @example opened */ action: string | null; /** + * @nullable * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * @nullable * @description The id of the repository associated with this event. * @example 123 */ repository_id: number | null; /** - * Format: date-time + * @nullable * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z + * @format date-time */ throttled_at?: string | null; /** @@ -19045,21 +19135,33 @@ export interface components { */ url?: string; request: { - /** @description The request headers sent with the webhook delivery. */ + /** + * @nullable + * @description The request headers sent with the webhook delivery. + */ headers: { [key: string]: unknown; } | null; - /** @description The webhook payload. */ + /** + * @nullable + * @description The webhook payload. + */ payload: { [key: string]: unknown; } | null; }; response: { - /** @description The response headers received when the delivery was made. */ + /** + * @nullable + * @description The response headers received when the delivery was made. + */ headers: { [key: string]: unknown; } | null; - /** @description The response payload received. */ + /** + * @nullable + * @description The response payload received. + */ payload: string | null; }; }; @@ -19078,8 +19180,8 @@ export interface components { account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; requester: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; }; @@ -19337,40 +19439,46 @@ export interface components { }; /** * Simple User + * @nullable * @description A GitHub user. */ "nullable-simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -19380,25 +19488,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -19419,6 +19527,7 @@ export interface components { * @example 1 */ id: number; + /** @nullable */ account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -19426,18 +19535,18 @@ export interface components { */ repository_selection: "all" | "selected"; /** - * Format: uri * @example https://api.github.com/app/installations/1/access_tokens + * @format uri */ access_tokens_url: string; /** - * Format: uri * @example https://api.github.com/installation/repositories + * @format uri */ repositories_url: string; /** - * Format: uri * @example https://github.com/organizations/github/settings/installations/1 + * @format uri */ html_url: string; /** @example 1 */ @@ -19448,11 +19557,14 @@ export interface components { target_type: string; permissions: components["schemas"]["app-permissions"]; events: string[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -19466,13 +19578,20 @@ export interface components { /** @example github-actions */ app_slug: string; suspended_by: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at: string | null; - /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ + /** + * @nullable + * @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" + */ contact_email?: string | null; }; /** * License Simple + * @nullable * @description License Simple */ "nullable-license-simple": { @@ -19481,15 +19600,19 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; } | null; /** @@ -19498,9 +19621,9 @@ export interface components { */ repository: { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -19528,16 +19651,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -19559,28 +19685,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -19602,13 +19728,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -19622,30 +19748,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -19653,25 +19779,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -19743,18 +19872,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -19872,7 +20004,10 @@ export interface components { */ single_file_paths?: string[]; }; - /** Scoped Installation */ + /** + * Scoped Installation + * @nullable + */ "nullable-scoped-installation": { permissions: components["schemas"]["app-permissions"]; /** @@ -19880,7 +20015,10 @@ export interface components { * @enum {string} */ repository_selection: "all" | "selected"; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -19892,8 +20030,8 @@ export interface components { */ single_file_paths?: string[]; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repositories_url: string; account: components["schemas"]["simple-user"]; @@ -19903,32 +20041,45 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { - /** Format: int64 */ + /** @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ url: string; - /** @description A list of scopes that this authorization is in. */ + /** + * @nullable + * @description A list of scopes that this authorization is in. + */ scopes: string[] | null; token: string; + /** @nullable */ token_last_eight: string | null; + /** @nullable */ hashed_token: string | null; app: { client_id: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; + /** @nullable */ note: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ note_url: string | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; + /** @nullable */ fingerprint: string | null; user?: components["schemas"]["nullable-simple-user"]; installation?: components["schemas"]["nullable-scoped-installation"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; }; /** @@ -19947,9 +20098,9 @@ export interface components { */ full_name: string; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; /** @@ -19977,11 +20128,14 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://github.com/github + * @format uri */ html_url: string; - /** @example Github - Code thigns happen here */ + /** + * @nullable + * @example Github - Code thigns happen here + */ name: string | null; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; @@ -20065,11 +20219,13 @@ export interface components { */ feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ max_teams: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20100,9 +20256,10 @@ export interface components { */ language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ deadline: string | null; starter_code_repository: components["schemas"]["simple-classroom-repository"]; @@ -20118,13 +20275,13 @@ export interface components { /** @example octocat */ login: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; }; @@ -20206,11 +20363,13 @@ export interface components { */ feedback_pull_requests_enabled: boolean; /** + * @nullable * @description The maximum allowable teams for the assignment. * @example 0 */ max_teams?: number | null; /** + * @nullable * @description The maximum allowable members per team. * @example 0 */ @@ -20241,9 +20400,10 @@ export interface components { */ language: string; /** - * Format: date-time + * @nullable * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z + * @format date-time */ deadline: string | null; classroom: components["schemas"]["simple-classroom"]; @@ -20320,8 +20480,8 @@ export interface components { /** @example Contributor Covenant */ name: string; /** - * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant + * @format uri */ url: string; /** @@ -20372,7 +20532,10 @@ export interface components { * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). */ body?: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; }; /** @description A code security configuration */ @@ -20423,14 +20586,21 @@ export interface components { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ code_scanning_default_setup_options?: { /** + * @nullable * @description Whether to use labeled runners or standard GitHub runners. * @enum {string|null} */ runner_type?: "standard" | "labeled" | "not_set" | null; - /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning when runner_type is 'labeled'. + */ runner_label?: string | null; } | null; /** @@ -20482,28 +20652,34 @@ export interface components { */ enforcement?: "enforced" | "unenforced"; /** - * Format: uri * @description The URL of the configuration + * @format uri */ url?: string; /** - * Format: uri * @description The URL of the configuration + * @format uri */ html_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }; - /** @description Feature options for code scanning default setup */ + /** + * @nullable + * @description Feature options for code scanning default setup + */ "code-scanning-default-setup-options": { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ runner_type?: "standard" | "labeled" | "not_set"; - /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + /** + * @nullable + * @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. + */ runner_label?: string | null; } | null; /** @description A list of default code security configurations */ @@ -20521,9 +20697,9 @@ export interface components { */ "simple-repository": { /** - * Format: int64 * @description A unique identifier of the repository. * @example 1296269 + * @format int64 */ id: number; /** @@ -20545,12 +20721,13 @@ export interface components { /** @description Whether the repository is private. */ private: boolean; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; /** + * @nullable * @description The repository description. * @example This your first repo! */ @@ -20558,9 +20735,9 @@ export interface components { /** @description Whether the repository is a fork. */ fork: boolean; /** - * Format: uri * @description The URL to get more information about the repository from the GitHub API. * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @@ -20609,33 +20786,33 @@ export interface components { */ contents_url: string; /** - * Format: uri * @description A template for the API URL to list the contributors to the repository. * @example https://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @description The API URL to list the deployments of the repository. * @example https://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @description The API URL to list the downloads on the repository. * @example https://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @description The API URL to list the events of the repository. * @example https://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @description The API URL to list the forks of the repository. * @example https://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @@ -20679,15 +20856,15 @@ export interface components { */ labels_url: string; /** - * Format: uri * @description The API URL to get information about the languages of the repository. * @example https://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @description The API URL to merge branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @@ -20711,9 +20888,9 @@ export interface components { */ releases_url: string; /** - * Format: uri * @description The API URL to list the stargazers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @@ -20722,27 +20899,27 @@ export interface components { */ statuses_url: string; /** - * Format: uri * @description The API URL to list the subscribers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @description The API URL to subscribe to notifications for this repository. * @example https://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @description The API URL to get information about tags on the repository. * @example https://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @description The API URL to list the teams on the repository. * @example https://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @@ -20751,9 +20928,9 @@ export interface components { */ trees_url: string; /** - * Format: uri * @description The API URL to list the hooks on the repository. * @example https://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; }; @@ -20785,7 +20962,10 @@ export interface components { readonly severity: "low" | "medium" | "high" | "critical"; /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ + /** + * @nullable + * @description Details pertaining to the package version that patches this vulnerability. + */ readonly first_patched_version: { /** @description The package version that patches this vulnerability. */ readonly identifier: string; @@ -20795,7 +20975,10 @@ export interface components { "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ + /** + * @nullable + * @description The unique CVE ID assigned to the advisory. + */ readonly cve_id: string | null; /** @description A short, plain text summary of the advisory. */ readonly summary: string; @@ -20812,7 +20995,10 @@ export interface components { readonly cvss: { /** @description The overall CVSS score of the advisory. */ readonly score: number; - /** @description The full CVSS vector string for the advisory. */ + /** + * @nullable + * @description The full CVSS vector string for the advisory. + */ readonly vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -20837,60 +21023,64 @@ export interface components { /** @description Links to additional advisory information. */ readonly references: { /** - * Format: uri * @description The URL of the reference. + * @format uri */ readonly url: string; }[]; /** - * Format: date-time * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly published_at: string; /** - * Format: date-time * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly updated_at: string; /** - * Format: date-time + * @nullable * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ readonly withdrawn_at: string | null; }; /** - * Format: uri * @description The REST API URL of the alert resource. + * @format uri */ "alert-url": string; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ "alert-html-url": string; /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-created-at": string; /** - * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-updated-at": string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-dismissed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-fixed-at": string | null; /** - * Format: date-time + * @nullable * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ @@ -20907,6 +21097,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -20921,19 +21112,24 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time + * @nullable * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "nullable-alert-updated-at": string | null; /** @@ -20942,6 +21138,7 @@ export interface components { */ "secret-scanning-alert-state": "open" | "resolved"; /** + * @nullable * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. * @enum {string|null} */ @@ -20953,15 +21150,16 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; @@ -20975,34 +21173,54 @@ export interface components { /** @description The secret that was detected. */ secret?: string; repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ + /** + * @nullable + * @description The comment that was optionally added when this alert was closed + */ resolution_comment?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ validity?: "active" | "inactive" | "unknown"; - /** @description Whether the secret was publicly leaked. */ + /** + * @nullable + * @description Whether the secret was publicly leaked. + */ publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. + */ multi_repo?: boolean | null; }; /** @@ -21013,30 +21231,32 @@ export interface components { id: number; login: string; display_login?: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ "nullable-milestone": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ labels_url: string; /** @example 1002604 */ @@ -21060,7 +21280,10 @@ export interface components { * @example v1.0 */ title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -21068,28 +21291,31 @@ export interface components { /** @example 8 */ closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ due_on: string | null; } | null; /** * GitHub app + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ "nullable-integration": { @@ -21113,26 +21339,29 @@ export interface components { * @example Probot Owners */ name: string; - /** @example The description of the app. */ + /** + * @nullable + * @example The description of the app. + */ description: string | null; /** - * Format: uri * @example https://example.com + * @format uri */ external_url: string; /** - * Format: uri * @example https://github.com/apps/super-ci + * @format uri */ html_url: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-07-08T16:18:44-04:00 + * @format date-time */ updated_at: string; /** @@ -21166,7 +21395,10 @@ export interface components { installations_count?: number; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ + /** + * @nullable + * @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" + */ webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; @@ -21180,7 +21412,7 @@ export interface components { "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** Reaction Rollup */ "reaction-rollup": { - /** Format: uri */ + /** @format uri */ url: string; total_count: number; "+1": number; @@ -21203,23 +21435,23 @@ export interface components { * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ issue: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -21232,6 +21464,7 @@ export interface components { */ state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -21243,6 +21476,7 @@ export interface components { */ title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -21256,45 +21490,67 @@ export interface components { * ] */ labels: (string | { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ url?: string; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; default?: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; comments: number; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; draft?: boolean; closed_by?: components["schemas"]["nullable-simple-user"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21308,16 +21564,16 @@ export interface components { */ "issue-comment": { /** - * Format: int64 * @description Unique identifier of the issue comment * @example 42 + * @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ url: string; /** @@ -21327,20 +21583,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -21352,12 +21608,13 @@ export interface components { */ event: { id: string; + /** @nullable */ type: string | null; actor: components["schemas"]["actor"]; repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; org?: components["schemas"]["actor"]; @@ -21368,6 +21625,7 @@ export interface components { pages?: { page_name?: string; title?: string; + /** @nullable */ summary?: string | null; action?: string; sha?: string; @@ -21375,7 +21633,10 @@ export interface components { }[]; }; public: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; }; /** @@ -21439,19 +21700,19 @@ export interface components { * @description Base Gist */ "base-gist": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -21468,15 +21729,16 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; + /** @nullable */ description: string | null; comments: number; comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: components["schemas"]["simple-user"]; truncated?: boolean; @@ -21489,7 +21751,7 @@ export interface components { */ "public-user": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; /** * @description discriminator enum property added by openapi-typescript @@ -21497,47 +21759,61 @@ export interface components { */ user_view_type: "public"; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; following_url: string; gists_url: string; starred_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; events_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; site_admin: boolean; + /** @nullable */ name: string | null; + /** @nullable */ company: string | null; + /** @nullable */ blog: string | null; + /** @nullable */ location: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ notification_email?: string | null; + /** @nullable */ hireable: boolean | null; + /** @nullable */ bio: string | null; + /** @nullable */ twitter_username?: string | null; public_repos: number; public_gists: number; followers: number; following: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; plan?: { collaborators: number; @@ -21563,14 +21839,14 @@ export interface components { "gist-history": { user?: components["schemas"]["nullable-simple-user"]; version?: string; - /** Format: date-time */ + /** @format date-time */ committed_at?: string; change_status?: { total?: number; additions?: number; deletions?: number; }; - /** Format: uri */ + /** @format uri */ url?: string; }; /** @@ -21578,37 +21854,44 @@ export interface components { * @description Gist Simple */ "gist-simple": { - /** @deprecated */ + /** + * @deprecated + * @nullable + */ forks?: { id?: string; - /** Format: uri */ + /** @format uri */ url?: string; user?: components["schemas"]["public-user"]; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }[] | null; - /** @deprecated */ + /** + * @deprecated + * @nullable + */ history?: components["schemas"]["gist-history"][] | null; /** * Gist + * @nullable * @description Gist */ fork_of?: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ forks_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; id: string; node_id: string; - /** Format: uri */ + /** @format uri */ git_pull_url: string; - /** Format: uri */ + /** @format uri */ git_push_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; files: { [key: string]: { @@ -21620,15 +21903,16 @@ export interface components { }; }; public: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; + /** @nullable */ description: string | null; comments: number; comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ + /** @format uri */ comments_url: string; owner?: components["schemas"]["nullable-simple-user"]; truncated?: boolean; @@ -21662,9 +21946,11 @@ export interface components { public?: boolean; created_at?: string; updated_at?: string; + /** @nullable */ description?: string | null; comments?: number; comments_enabled?: boolean; + /** @nullable */ user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -21680,8 +21966,8 @@ export interface components { /** @example MDExOkdpc3RDb21tZW50MQ== */ node_id: string; /** - * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + * @format uri */ url: string; /** @@ -21691,13 +21977,13 @@ export interface components { body: string; user: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-18T23:23:56Z + * @format date-time */ updated_at: string; author_association: components["schemas"]["author-association"]; @@ -21708,8 +21994,8 @@ export interface components { */ "gist-commit": { /** - * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + * @format uri */ url: string; /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ @@ -21721,8 +22007,8 @@ export interface components { deletions?: number; }; /** - * Format: date-time * @example 2010-04-14T02:15:15Z + * @format date-time */ committed_at: string; }; @@ -21764,15 +22050,19 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; }; /** @@ -21784,18 +22074,22 @@ export interface components { key: string; /** @example MIT License */ name: string; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; /** - * Format: uri * @example http://choosealicense.com/licenses/mit/ + * @format uri */ html_url: string; /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ @@ -21857,13 +22151,13 @@ export interface components { */ "marketplace-listing-plan": { /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts + * @format uri */ accounts_url: string; /** @example 1313 */ @@ -21885,6 +22179,7 @@ export interface components { price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; /** @example true */ has_free_trial: boolean; + /** @nullable */ unit_name: string | null; /** @example published */ state: string; @@ -21906,20 +22201,26 @@ export interface components { id: number; login: string; organization_billing_email?: string; + /** @nullable */ email?: string | null; + /** @nullable */ marketplace_pending_change?: { is_installed?: boolean; effective_date?: string; + /** @nullable */ unit_count?: number | null; id?: number; plan?: components["schemas"]["marketplace-listing-plan"]; } | null; marketplace_purchase: { billing_cycle?: string; + /** @nullable */ next_billing_date?: string | null; is_installed?: boolean; + /** @nullable */ unit_count?: number | null; on_free_trial?: boolean; + /** @nullable */ free_trial_ends_on?: string | null; updated_at?: string; plan?: components["schemas"]["marketplace-listing-plan"]; @@ -22043,6 +22344,7 @@ export interface components { }; }; }; + /** @nullable */ "security-and-analysis": { advanced_security?: { /** @enum {string} */ @@ -22079,8 +22381,8 @@ export interface components { */ "minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -22092,16 +22394,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -22123,28 +22428,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -22165,13 +22470,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -22184,43 +22489,46 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ trees_url: string; clone_url?: string; + /** @nullable */ mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; svn_url?: string; + /** @nullable */ homepage?: string | null; + /** @nullable */ language?: string | null; forks_count?: number; stargazers_count?: number; @@ -22241,18 +22549,21 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at?: string | null; permissions?: { @@ -22269,6 +22580,7 @@ export interface components { subscribers_count?: number; network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ license?: { key?: string; name?: string; @@ -22303,6 +22615,7 @@ export interface components { reason: string; unread: boolean; updated_at: string; + /** @nullable */ last_read_at: string | null; url: string; /** @example https://api.github.com/notifications/threads/2/subscription */ @@ -22316,25 +22629,27 @@ export interface components { /** @example true */ subscribed: boolean; ignored: boolean; + /** @nullable */ reason: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-06T21:34:12Z + * @format date-time */ created_at: string | null; /** - * Format: uri * @example https://api.github.com/notifications/threads/1/subscription + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/notifications/threads/1 + * @format uri */ thread_url?: string; /** - * Format: uri * @example https://api.github.com/repos/1 + * @format uri */ repository_url?: string; }; @@ -22350,18 +22665,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22374,7 +22689,10 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; }; "billing-usage-report": { @@ -22415,18 +22733,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -22439,25 +22757,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -22474,8 +22798,8 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** @example Organization */ @@ -22484,11 +22808,18 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; /** + * @nullable * @description The number of collaborators on private repositories. * * This field may be null if the number of private repositories is over 50,000. @@ -22496,8 +22827,9 @@ export interface components { */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -22507,10 +22839,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -22526,7 +22865,10 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; @@ -22596,18 +22938,22 @@ export interface components { */ secret_scanning_push_protection_custom_link_enabled?: boolean; /** + * @nullable * @description An optional URL string to display to contributors who are blocked from pushing a secret. * @example https://github.com/test-org/test-repo/blob/main/README.md */ secret_scanning_push_protection_custom_link?: string | null; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ archived_at: string | null; /** * @description Controls whether or not deploy keys may be added and used for repositories in the organization. @@ -22644,6 +22990,7 @@ export interface components { }; /** * GitHub-hosted runner image details. + * @nullable * @description Provides details of a hosted runner image */ "nullable-actions-hosted-runner-pool-image": { @@ -22767,9 +23114,10 @@ export interface components { /** @description The public IP ranges when public IP is enabled for the hosted runners. */ public_ips?: components["schemas"]["public-ip"][]; /** - * Format: date-time + * @nullable * @description The time at which the runner was last used, in ISO 8601 format. * @example 2022-10-09T23:39:01Z + * @format date-time */ last_active_on?: string | null; }; @@ -22981,9 +23329,9 @@ export interface components { */ token: string; /** - * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z + * @format date-time */ expires_at: string; /** @@ -22995,7 +23343,10 @@ export interface components { permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file?: string | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -23013,9 +23364,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -23023,8 +23374,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23068,15 +23419,15 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ updated_at: string; /** @@ -23085,14 +23436,17 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/variables/USERNAME/repositories + * @format uri */ selected_repositories_url?: string; }; /** @description The name of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-name": string; - /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + /** + * @nullable + * @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. + */ "code-scanning-analysis-tool-guid": string | null; /** * @description State of a code scanning alert. @@ -23105,33 +23459,43 @@ export interface components { */ "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; /** - * Format: uri * @description The REST API URL for fetching the list of instances for an alert. + * @format uri */ "alert-instances-url": string; /** + * @nullable * @description State of a code scanning alert. * @enum {string|null} */ "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** + * @nullable * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; - /** @description The dismissal comment associated with the dismissal of the alert. */ + /** + * @nullable + * @description The dismissal comment associated with the dismissal of the alert. + */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -23140,14 +23504,26 @@ export interface components { description?: string; /** @description A description of the rule used to detect the alert. */ full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; }; - /** @description The version of the tool used to generate the code scanning analysis. */ + /** + * @nullable + * @description The version of the tool used to generate the code scanning analysis. + */ "code-scanning-analysis-tool-version": string | null; "code-scanning-analysis-tool": { name?: components["schemas"]["code-scanning-analysis-tool-name"]; @@ -23174,6 +23550,7 @@ export interface components { end_column?: number; }; /** + * @nullable * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ @@ -23216,6 +23593,7 @@ export interface components { }; /** * Codespace machine + * @nullable * @description A description of the machine powering a codespace. */ "nullable-codespace-machine": { @@ -23250,6 +23628,7 @@ export interface components { */ cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -23262,8 +23641,8 @@ export interface components { */ codespace: { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -23272,11 +23651,13 @@ export interface components { */ name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -23286,29 +23667,31 @@ export interface components { repository: components["schemas"]["minimal-repository"]; machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ last_used_at: string; /** @@ -23318,8 +23701,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -23351,63 +23734,81 @@ export interface components { */ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ allowed_port_privacy_settings?: string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ retention_expires_at?: string | null; /** + * @nullable * @description The text to display to a user when a codespace has been stopped for a potentially actionable reason. * @example you've used 100% of your spending limit for Codespaces */ @@ -23424,13 +23825,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -23439,9 +23840,9 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23528,6 +23929,7 @@ export interface components { }; /** * Organization Simple + * @nullable * @description A GitHub organization. */ "nullable-organization-simple": { @@ -23538,18 +23940,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -23562,11 +23964,15 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; } | null; /** * Team Simple + * @nullable * @description Groups of organization members that gives permissions on specified repositories. */ "nullable-team-simple": { @@ -23578,9 +23984,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -23591,6 +23997,7 @@ export interface components { */ name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -23611,13 +24018,13 @@ export interface components { */ notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; /** @example justice-league */ @@ -23637,6 +24044,7 @@ export interface components { node_id: string; name: string; slug: string; + /** @nullable */ description: string | null; privacy?: string; notification_setting?: string; @@ -23648,15 +24056,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; @@ -23665,27 +24073,33 @@ export interface components { * @description Group of enterprise owners and/or members */ "enterprise-team": { - /** Format: int64 */ + /** @format int64 */ id: number; name: string; slug: string; - /** Format: uri */ + /** @format uri */ url: string; /** @example disabled | all */ sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + /** + * @nullable + * @example 62ab9291-fae2-468e-974b-7e45096d5021 + */ group_id?: string | null; - /** @example Justice League */ + /** + * @nullable + * @example Justice League + */ group_name?: string | null; /** - * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league + * @format uri */ html_url: string; members_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -23695,29 +24109,37 @@ export interface components { "copilot-seat-details": { assignee: components["schemas"]["simple-user"]; organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + /** + * @nullable + * @description The team through which the assignee is granted access to GitHub Copilot, if applicable. + */ assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** - * Format: date + * @nullable * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @format date */ pending_cancellation_date?: string | null; /** - * Format: date-time + * @nullable * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @format date-time */ last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + /** + * @nullable + * @description Last editor that was used by the user for a GitHub Copilot completion. + */ last_activity_editor?: string | null; /** - * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @format date-time */ created_at: string; /** - * Format: date-time * @deprecated * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @format date-time */ updated_at?: string; /** @@ -23726,7 +24148,10 @@ export interface components { */ plan_type?: "business" | "enterprise" | "unknown"; }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot editor code completions in the IDE. + */ "copilot-ide-code-completions": ({ /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ total_engaged_users?: number; @@ -23748,7 +24173,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date?: string | null; /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ total_engaged_users?: number; @@ -23774,7 +24202,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in the IDE. + */ "copilot-ide-chat": ({ /** @description Total number of users who prompted Copilot Chat in the IDE. */ total_engaged_users?: number; @@ -23789,7 +24220,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date?: string | null; /** @description The number of users who prompted Copilot Chat in the given editor and model. */ total_engaged_users?: number; @@ -23804,7 +24238,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** + * @nullable + * @description Usage metrics for Copilot Chat in github.com + */ "copilot-dotcom-chat": ({ /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ total_engaged_users?: number; @@ -23814,7 +24251,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ + /** + * @nullable + * @description The training date for the custom model (if applicable). + */ custom_model_training_date?: string | null; /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ total_engaged_users?: number; @@ -23824,7 +24264,10 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot for pull requests. */ + /** + * @nullable + * @description Usage metrics for Copilot for pull requests. + */ "copilot-dotcom-pull-requests": ({ /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ total_engaged_users?: number; @@ -23840,7 +24283,10 @@ export interface components { name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; - /** @description The training date for the custom model. */ + /** + * @nullable + * @description The training date for the custom model. + */ custom_model_training_date?: string | null; /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ total_pr_summaries_created?: number; @@ -23857,8 +24303,8 @@ export interface components { */ "copilot-usage-metrics-day": { /** - * Format: date * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @format date */ date: string; /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ @@ -23878,8 +24324,8 @@ export interface components { */ "copilot-usage-metrics": { /** - * Format: date * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @format date */ day: string; /** @description The total number of Copilot code completion suggestions shown to users. */ @@ -23898,7 +24344,10 @@ export interface components { total_chat_turns?: number; /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ + /** + * @nullable + * @description Breakdown of Copilot code completions usage by language and editor + */ breakdown: ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ language?: string; @@ -23928,9 +24377,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** * @description Visibility of a secret @@ -23938,8 +24387,8 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories + * @format uri */ selected_repositories_url?: string; }; @@ -23961,12 +24410,13 @@ export interface components { }; /** * Minimal Repository + * @nullable * @description Minimal Repository */ "nullable-minimal-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -23978,16 +24428,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -24009,28 +24462,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -24051,13 +24504,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -24070,43 +24523,46 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ trees_url: string; clone_url?: string; + /** @nullable */ mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; svn_url?: string; + /** @nullable */ homepage?: string | null; + /** @nullable */ language?: string | null; forks_count?: number; stargazers_count?: number; @@ -24127,18 +24583,21 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at?: string | null; permissions?: { @@ -24155,6 +24614,7 @@ export interface components { subscribers_count?: number; network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ license?: { key?: string; name?: string; @@ -24209,9 +24669,9 @@ export interface components { visibility: "private" | "public"; owner?: components["schemas"]["nullable-simple-user"]; repository?: components["schemas"]["nullable-minimal-repository"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24219,13 +24679,17 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { - /** Format: int64 */ + /** @format int64 */ id: number; + /** @nullable */ login: string | null; + /** @nullable */ email: string | null; role: string; created_at: string; + /** @nullable */ failed_at?: string | null; + /** @nullable */ failed_reason?: string | null; inviter: components["schemas"]["simple-user"]; team_count: number; @@ -24244,18 +24708,18 @@ export interface components { /** @example 1 */ id: number; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings + * @format uri */ ping_url: string; /** - * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries + * @format uri */ deliveries_url?: string; /** @example web */ @@ -24280,13 +24744,13 @@ export interface components { secret?: string; }; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ created_at: string; type: string; @@ -24301,15 +24765,16 @@ export interface components { /** @description The API path's route template */ api_route?: string; /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count?: number; + /** @nullable */ last_rate_limited_timestamp?: string | null; last_request_timestamp?: string; }[]; @@ -24320,10 +24785,11 @@ export interface components { "api-insights-subject-stats": { subject_type?: string; subject_name?: string; - /** Format: int64 */ + /** @format int64 */ subject_id?: number; total_request_count?: number; rate_limited_request_count?: number; + /** @nullable */ last_rate_limited_timestamp?: string | null; last_request_timestamp?: string; }[]; @@ -24333,13 +24799,13 @@ export interface components { */ "api-insights-summary-stats": { /** - * Format: int64 * @description The total number of requests within the queried time period + * @format int64 */ total_request_count?: number; /** - * Format: int64 * @description The total number of requests that were rate limited within the queried time period + * @format int64 */ rate_limited_request_count?: number; }; @@ -24349,9 +24815,9 @@ export interface components { */ "api-insights-time-stats": { timestamp?: string; - /** Format: int64 */ + /** @format int64 */ total_request_count?: number; - /** Format: int64 */ + /** @format int64 */ rate_limited_request_count?: number; }[]; /** @@ -24361,14 +24827,21 @@ export interface components { "api-insights-user-stats": { actor_type?: string; actor_name?: string; - /** Format: int64 */ + /** @format int64 */ actor_id?: number; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ integration_id?: number | null; - /** Format: int64 */ + /** + * @nullable + * @format int64 + */ oauth_application_id?: number | null; total_request_count?: number; rate_limited_request_count?: number; + /** @nullable */ last_rate_limited_timestamp?: string | null; last_request_timestamp?: string; }[]; @@ -24387,8 +24860,8 @@ export interface components { /** @example repository */ origin: string; /** - * Format: date-time * @example 2018-08-17T04:18:39Z + * @format date-time */ expires_at: string; }; @@ -24412,8 +24885,8 @@ export interface components { */ "org-membership": { /** - * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt + * @format uri */ url: string; /** @@ -24429,8 +24902,8 @@ export interface components { */ role: "admin" | "member" | "billing_manager"; /** - * Format: uri * @example https://api.github.com/orgs/octocat + * @format uri */ organization_url: string; organization: components["schemas"]["organization-simple"]; @@ -24445,8 +24918,8 @@ export interface components { */ migration: { /** - * Format: int64 * @example 79 + * @format int64 */ id: number; owner: components["schemas"]["nullable-simple-user"]; @@ -24465,22 +24938,22 @@ export interface components { /** @description The repositories included in the migration. Only returned for export migrations. */ repositories: components["schemas"]["repository"][]; /** - * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 + * @format uri */ url: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2015-07-06T15:33:38-07:00 + * @format date-time */ updated_at: string; node_id: string; - /** Format: uri */ + /** @format uri */ archive_url?: string; /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; @@ -24491,20 +24964,25 @@ export interface components { */ "organization-role": { /** - * Format: int64 * @description The unique identifier of the role. + * @format int64 */ 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. */ + /** + * @nullable + * @description A short description about who this role is for or what permissions it grants. + */ description?: string | null; /** + * @nullable * @description The system role from which this role inherits permissions. * @enum {string|null} */ base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; /** + * @nullable * @description Source answers the question, "where did this role come from?" * @enum {string|null} */ @@ -24513,13 +24991,13 @@ export interface components { permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @description The date and time the role was created. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time the role was last updated. + * @format date-time */ updated_at: string; }; @@ -24538,6 +25016,7 @@ export interface components { node_id: string; name: string; slug: string; + /** @nullable */ description: string | null; privacy?: string; notification_setting?: string; @@ -24549,15 +25028,15 @@ export interface components { maintain: boolean; admin: boolean; }; - /** Format: uri */ + /** @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; members_url: string; - /** Format: uri */ + /** @format uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; @@ -24574,9 +25053,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -24587,6 +25066,7 @@ export interface components { */ name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -24607,13 +25087,13 @@ export interface components { */ notification_setting?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; /** @example justice-league */ @@ -24637,7 +25117,9 @@ export interface components { assignment?: "direct" | "indirect" | "mixed"; /** @description Team the user has gotten the role through */ inherited_from?: components["schemas"]["team-simple"][]; + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; @@ -24646,25 +25128,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -24674,25 +25159,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -24728,18 +25213,18 @@ export interface components { license?: string; description?: string; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ deleted_at?: string; /** Package Version Metadata */ @@ -24766,7 +25251,10 @@ export interface components { "organization-programmatic-access-grant-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */ id: number; - /** @description Reason for requesting access. */ + /** + * @nullable + * @description Reason for requesting access. + */ reason: string | null; owner: components["schemas"]["simple-user"]; /** @@ -24796,9 +25284,15 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** @@ -24836,9 +25330,15 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** @@ -24857,6 +25357,7 @@ export interface components { */ registry_type: "maven_repository"; /** + * @nullable * @description The username to use when authenticating with the private registry. * @example monalisa */ @@ -24866,9 +25367,9 @@ export interface components { * @enum {string} */ visibility: "all" | "private" | "selected"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24898,9 +25399,9 @@ export interface components { visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ selected_repository_ids?: number[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -24909,23 +25410,23 @@ export interface components { */ project: { /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test + * @format uri */ owner_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/projects/1002604/columns + * @format uri */ columns_url: string; /** @example 1002604 */ @@ -24938,6 +25439,7 @@ export interface components { */ name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -24951,13 +25453,13 @@ export interface components { state: string; creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** @@ -24976,8 +25478,8 @@ export interface components { /** @description The name of the property */ property_name: string; /** - * Format: uri * @description The URL that can be used to fetch, update, or delete info about this property via the API. + * @format uri */ url?: string; /** @@ -24994,16 +25496,24 @@ export interface components { value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ default_value?: (string | string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; /** + * @nullable * @description Who can edit the values of the property * @example org_actors * @enum {string|null} @@ -25023,11 +25533,18 @@ export interface components { value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; - /** @description Default value of the property */ + /** + * @nullable + * @description Default value of the property + */ default_value?: (string | string[]) | null; - /** @description Short description of the property */ + /** + * @nullable + * @description Short description of the property + */ description?: string | null; /** + * @nullable * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ @@ -25040,7 +25557,10 @@ export interface components { "custom-property-value": { /** @description The name of the property */ property_name: string; - /** @description The value assigned to the property */ + /** + * @nullable + * @description The value assigned to the property + */ value: (string | string[]) | null; }; /** @@ -25059,13 +25579,14 @@ export interface components { }; /** * Repository + * @nullable * @description A repository on GitHub. */ "nullable-repository": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25093,16 +25614,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25124,28 +25648,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25167,13 +25691,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25187,30 +25711,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25218,25 +25742,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -25308,18 +25835,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -25420,8 +25950,8 @@ export interface components { */ "code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ url: string; /** @example citizen_code_of_conduct */ @@ -25429,8 +25959,9 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ html_url: string | null; }; @@ -25440,8 +25971,8 @@ export interface components { */ "full-repository": { /** - * Format: int64 * @example 1296269 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -25453,16 +25984,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -25484,28 +26018,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -25527,13 +26061,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -25547,30 +26081,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -25578,25 +26112,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -25644,18 +26181,18 @@ export interface components { */ visibility?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string; permissions?: { @@ -25668,6 +26205,7 @@ export interface components { /** @example true */ allow_rebase_merge?: boolean; template_repository?: components["schemas"]["nullable-repository"]; + /** @nullable */ temp_clone_token?: string | null; /** @example true */ allow_squash_merge?: boolean; @@ -25757,7 +26295,10 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** + * @nullable + * @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -26238,16 +26779,18 @@ export interface components { /** @description The URL of the ruleset */ href?: string; }; + /** @nullable */ html?: { /** @description The html URL of the ruleset */ href?: string; } | null; }; + /** @nullable */ conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; rules?: components["schemas"]["repository-rule"][]; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; }; /** @@ -26272,8 +26815,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string; /** @@ -26294,9 +26837,15 @@ export interface components { "rule-suite": { /** @description The unique identifier of the rule insight. */ id?: number; - /** @description The number that identifies the user. */ + /** + * @nullable + * @description The number that identifies the user. + */ actor_id?: number | null; - /** @description The handle for the GitHub user account. */ + /** + * @nullable + * @description The handle for the GitHub user account. + */ actor_name?: string | null; /** @description The first commit sha before the push evaluation. */ before_sha?: string; @@ -26309,8 +26858,8 @@ export interface components { /** @description The name of the repository without the `.git` extension. */ repository_name?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string; /** @@ -26319,6 +26868,7 @@ export interface components { */ result?: "pass" | "fail" | "bypass"; /** + * @nullable * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. * @enum {string|null} */ @@ -26328,9 +26878,15 @@ export interface components { rule_source?: { /** @description The type of rule source. */ type?: string; - /** @description The ID of the rule source. */ + /** + * @nullable + * @description The ID of the rule source. + */ id?: number | null; - /** @description The name of the rule source. */ + /** + * @nullable + * @description The name of the rule source. + */ name?: string | null; }; /** @@ -26345,23 +26901,41 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description The detailed failure message for the rule. Null if the rule passed. */ + /** + * @nullable + * @description The detailed failure message for the rule. Null if the rule passed. + */ details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ + /** + * @nullable + * @description The name of the package affected by the vulnerability. + */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name: string | null; } | null; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions: string[] | null; }; /** @description A credit given to a user for a repository security advisory. */ @@ -26378,30 +26952,43 @@ export interface components { "repository-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id: string | null; /** - * Format: uri * @description The API URL for the advisory. + * @format uri */ readonly url: string; /** - * Format: uri * @description The URL for the advisory. + * @format uri */ readonly html_url: string; /** @description A short summary of the advisory. */ summary: string; - /** @description A detailed description of what the advisory entails. */ + /** + * @nullable + * @description A detailed description of what the advisory entails. + */ description: string | null; /** + * @nullable * @description The severity of the advisory. * @enum {string|null} */ severity: "critical" | "high" | "medium" | "low" | null; - /** @description The author of the advisory. */ + /** + * @nullable + * @description The author of the advisory. + */ readonly author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ + /** + * @nullable + * @description The publisher of the advisory. + */ readonly publisher: components["schemas"]["simple-user"] | null; readonly identifiers: { /** @@ -26418,61 +27005,90 @@ export interface components { */ state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was created, in ISO 8601 format. + * @format date-time */ readonly created_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * @format date-time */ readonly updated_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was published, in ISO 8601 format. + * @format date-time */ readonly published_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was closed, in ISO 8601 format. + * @format date-time */ readonly closed_at: string | null; /** - * Format: date-time + * @nullable * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * @format date-time */ readonly withdrawn_at: string | null; + /** @nullable */ readonly submission: { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; + /** @nullable */ vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + /** @nullable */ cvss: { - /** @description The CVSS vector. */ + /** + * @nullable + * @description The CVSS vector. + */ vector_string: string | null; - /** @description The CVSS score. */ + /** + * @nullable + * @description The CVSS score. + */ readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; + /** @nullable */ readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - /** @description A list of only the CWE IDs. */ + /** + * @nullable + * @description A list of only the CWE IDs. + */ cwe_ids: string[] | null; + /** @nullable */ credits: { /** @description The username of the user credited. */ login?: string; type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; + /** @nullable */ readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ + /** + * @nullable + * @description A list of users that collaborate on the advisory. + */ collaborating_users: components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ + /** + * @nullable + * @description A list of teams that collaborate on the advisory. + */ collaborating_teams: components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + /** + * @nullable + * @description A temporary private fork of the advisory's repository for collaborating on a fix. + */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; "actions-billing-usage": { @@ -26557,9 +27173,10 @@ export interface components { */ network_settings_ids?: string[]; /** - * Format: date-time + * @nullable * @description The time at which the network configuration was created, in ISO 8601 format. * @example 2024-04-26T11:31:07Z + * @format date-time */ created_on: string | null; }; @@ -26606,18 +27223,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -26630,25 +27247,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -26665,13 +27288,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** @example Organization */ @@ -26680,15 +27303,25 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; - /** @example 8 */ + /** + * @nullable + * @example 8 + */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -26698,10 +27331,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -26717,13 +27357,19 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ archived_at: string | null; }; /** @@ -26739,14 +27385,14 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** @@ -26756,7 +27402,10 @@ export interface components { name: string; /** @example justice-league */ slug: string; - /** @example A great team. */ + /** + * @nullable + * @example A great team. + */ description: string | null; /** * @description The level of privacy this team should have @@ -26778,8 +27427,8 @@ export interface components { /** @example https://api.github.com/organizations/1/team/1/members{/member} */ members_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; parent?: components["schemas"]["nullable-team-simple"]; @@ -26788,13 +27437,13 @@ export interface components { /** @example 10 */ repos_count: number; /** - * Format: date-time * @example 2017-07-14T16:53:42Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-08-17T12:37:15Z + * @format date-time */ updated_at: string; organization: components["schemas"]["team-organization"]; @@ -26825,20 +27474,23 @@ export interface components { /** @example 0 */ comments_count: number; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments + * @format uri */ comments_url: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ last_edited_at: string | null; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 + * @format uri */ html_url: string; /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ @@ -26859,8 +27511,8 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027 + * @format uri */ team_url: string; /** @@ -26869,13 +27521,13 @@ export interface components { */ title: string; /** - * Format: date-time * @example 2018-01-25T18:56:31Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 + * @format uri */ url: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -26899,20 +27551,23 @@ export interface components { */ body_version: string; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ last_edited_at: string | null; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @format uri */ discussion_url: string; /** - * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @format uri */ html_url: string; /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ @@ -26923,13 +27578,13 @@ export interface components { */ number: number; /** - * Format: date-time * @example 2018-01-15T23:53:58Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + * @format uri */ url: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -26951,8 +27606,8 @@ export interface components { */ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** - * Format: date-time * @example 2016-05-20T20:09:31Z + * @format date-time */ created_at: string; }; @@ -26961,7 +27616,7 @@ export interface components { * @description Team Membership */ "team-membership": { - /** Format: uri */ + /** @format uri */ url: string; /** * @description The role of the user in the team. @@ -26988,6 +27643,7 @@ export interface components { id: number; node_id: string; name: string; + /** @nullable */ body: string | null; number: number; state: string; @@ -27041,16 +27697,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -27072,28 +27731,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -27115,13 +27774,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -27135,30 +27794,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -27166,25 +27825,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -27246,18 +27908,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -27315,29 +27980,32 @@ export interface components { */ "project-card": { /** - * Format: uri * @example https://api.github.com/projects/columns/cards/1478 + * @format uri */ url: string; /** - * Format: int64 * @description The project card's ID * @example 42 + * @format int64 */ id: number; /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ node_id: string; - /** @example Add payload for delete Project column */ + /** + * @nullable + * @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 + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2016-09-05T14:20:22Z + * @format date-time */ updated_at: string; /** @@ -27348,18 +28016,18 @@ export interface components { column_name?: string; project_id?: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ column_url: string; /** - * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 + * @format uri */ content_url?: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ project_url: string; }; @@ -27369,18 +28037,18 @@ export interface components { */ "project-column": { /** - * Format: uri * @example https://api.github.com/projects/columns/367 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/projects/120 + * @format uri */ project_url: string; /** - * Format: uri * @example https://api.github.com/projects/columns/367/cards + * @format uri */ cards_url: string; /** @@ -27396,13 +28064,13 @@ export interface components { */ name: string; /** - * Format: date-time * @example 2016-09-05T14:18:44Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2016-09-05T14:22:28Z + * @format date-time */ updated_at: string; }; @@ -27466,12 +28134,22 @@ export interface components { archive_download_url: string; /** @description Whether or not the artifact has expired. */ expired: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; + /** @nullable */ workflow_run?: { /** @example 10 */ id?: number; @@ -27506,13 +28184,13 @@ export interface components { /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ version?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ last_accessed_at?: string; /** - * Format: date-time * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at?: string; /** @example 1024 */ @@ -27550,7 +28228,10 @@ export interface components { head_sha: string; /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ html_url: string | null; /** * @description The phase of the lifecycle that the job is currently in. @@ -27559,27 +28240,29 @@ export interface components { */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @description The outcome of the job. * @example success * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time * @description The time that the job created, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ started_at: string; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ completed_at: string | null; /** @@ -27596,6 +28279,7 @@ export interface components { */ status: "queued" | "in_progress" | "completed"; /** + * @nullable * @description The outcome of the job. * @example success */ @@ -27608,15 +28292,17 @@ export interface components { /** @example 1 */ number: number; /** - * Format: date-time + * @nullable * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ started_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 + * @format date-time */ completed_at?: string | null; }[]; @@ -27632,31 +28318,37 @@ export interface components { */ labels: string[]; /** + * @nullable * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ runner_id: number | null; /** + * @nullable * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ runner_name: string | null; /** + * @nullable * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ runner_group_id: number | null; /** + * @nullable * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ runner_group_name: string | null; /** + * @nullable * @description The name of the workflow. * @example Build */ workflow_name: string | null; /** + * @nullable * @description The name of the current branch. * @example main */ @@ -27682,9 +28374,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** Actions Variable */ @@ -27700,15 +28392,15 @@ export interface components { */ value: string; /** - * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z + * @format date-time */ updated_at: string; }; @@ -27740,7 +28432,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { - /** Format: int64 */ + /** @format int64 */ id: number; number: number; url: string; @@ -27748,7 +28440,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -27758,7 +28450,7 @@ export interface components { ref: string; sha: string; repo: { - /** Format: int64 */ + /** @format int64 */ id: number; url: string; name: string; @@ -27767,6 +28459,7 @@ export interface components { }; /** * Simple Commit + * @nullable * @description A commit. */ "nullable-simple-commit": { @@ -27783,12 +28476,15 @@ export interface components { */ message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ author: { /** * @description Name of the commit's author @@ -27796,13 +28492,16 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ committer: { /** * @description Name of the commit's committer @@ -27810,9 +28509,9 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; @@ -27828,6 +28527,7 @@ export interface components { */ id: number; /** + * @nullable * @description The name of the workflow run. * @example Build */ @@ -27844,7 +28544,10 @@ export interface components { * @example MDEwOkNoZWNrU3VpdGU0Mg== */ check_suite_node_id?: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that points to the version of the workflow being run. @@ -27866,12 +28569,19 @@ export interface components { * @example 1 */ run_attempt?: number; + /** @nullable */ referenced_workflows?: components["schemas"]["referenced-workflow"][] | null; /** @example push */ event: string; - /** @example completed */ + /** + * @nullable + * @example completed + */ status: string | null; - /** @example neutral */ + /** + * @nullable + * @example neutral + */ conclusion: string | null; /** * @description The ID of the parent workflow. @@ -27885,17 +28595,20 @@ export interface components { url: string; /** @example https://github.com/github/hello-world/suites/4 */ html_url: string; - /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */ + /** + * @nullable + * @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. + */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; actor?: components["schemas"]["simple-user"]; triggering_actor?: components["schemas"]["simple-user"]; /** - * Format: date-time * @description The start time of the latest run. Resets on re-run. + * @format date-time */ run_started_at?: string; /** @@ -27929,6 +28642,7 @@ export interface components { */ rerun_url: string; /** + * @nullable * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ @@ -27973,15 +28687,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url?: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ created_at?: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ updated_at?: string; }[]; @@ -28028,9 +28742,9 @@ export interface components { "pending-deployment": { environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -28051,9 +28765,10 @@ export interface components { */ wait_timer: number; /** - * Format: date-time + * @nullable * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z + * @format date-time */ wait_timer_started_at: string | null; /** @@ -28073,14 +28788,14 @@ export interface components { */ deployment: { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ url: string; /** - * Format: int64 * @description Unique identifier of the deployment * @example 42 + * @format int64 */ id: number; /** @example MDEwOkRlcGxveW1lbnQx */ @@ -28107,27 +28822,30 @@ export interface components { * @example production */ environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** @@ -28194,13 +28912,13 @@ export interface components { */ state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ updated_at: string; /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ @@ -28210,8 +28928,8 @@ export interface components { /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ badge_url: string; /** - * Format: date-time * @example 2019-12-06T14:20:20.000Z + * @format date-time */ deleted_at?: string; }; @@ -28257,9 +28975,9 @@ export interface components { */ ref: string; /** - * Format: date-time * @description The time when the activity occurred. * @example 2011-01-26T19:06:43Z + * @format date-time */ timestamp: string; /** @@ -28319,6 +29037,7 @@ export interface components { contexts: string[]; checks: { context: string; + /** @nullable */ app_id: number | null; }[]; contexts_url?: string; @@ -28330,8 +29049,8 @@ export interface components { */ "protected-branch-admin-enforced": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + * @format uri */ url: string; /** @example true */ @@ -28343,8 +29062,8 @@ export interface components { */ "protected-branch-pull-request-review": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + * @format uri */ url?: string; dismissal_restrictions?: { @@ -28388,17 +29107,17 @@ export interface components { * @description Branch Restriction Policy */ "branch-restriction-policy": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ apps_url: string; users: { login?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -28425,12 +29144,14 @@ export interface components { html_url?: string; name?: string; slug?: string; + /** @nullable */ description?: string | null; privacy?: string; notification_setting?: string; permission?: string; members_url?: string; repositories_url?: string; + /** @nullable */ parent?: string | null; }[]; apps: { @@ -28523,8 +29244,8 @@ export interface components { protection_url?: string; required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ url: string; /** @example true */ @@ -28549,16 +29270,17 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; protected: boolean; protection?: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url?: string; }; /** * Git User + * @nullable * @description Metaproperties for Git author/committer information. */ "nullable-git-user": { @@ -28573,8 +29295,11 @@ export interface components { verification: { verified: boolean; reason: string; + /** @nullable */ payload: string | null; + /** @nullable */ signature: string | null; + /** @nullable */ verified_at?: string | null; }; /** @@ -28598,18 +29323,18 @@ export interface components { /** @example 124 */ changes: number; /** - * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ blob_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + * @format uri */ raw_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ contents_url: string; /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ @@ -28623,8 +29348,8 @@ export interface components { */ commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ url: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ @@ -28632,19 +29357,19 @@ export interface components { /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + * @format uri */ comments_url: string; commit: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ url: string; author: components["schemas"]["nullable-git-user"]; @@ -28657,26 +29382,28 @@ export interface components { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + * @format uri */ url: string; }; verification?: components["schemas"]["verification"]; }; + /** @nullable */ author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + /** @nullable */ committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + * @format uri */ html_url?: string; }[]; @@ -28696,12 +29423,12 @@ export interface components { commit: components["schemas"]["commit"]; _links: { html: string; - /** Format: uri */ + /** @format uri */ self: string; }; protected: boolean; protection: components["schemas"]["branch-protection"]; - /** Format: uri */ + /** @format uri */ protection_url: string; /** @example "mas*" */ pattern?: string; @@ -28714,8 +29441,8 @@ export interface components { */ "status-check-policy": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + * @format uri */ url: string; /** @example true */ @@ -28729,11 +29456,12 @@ export interface components { checks: { /** @example continuous-integration/travis-ci */ context: string; + /** @nullable */ app_id: number | null; }[]; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + * @format uri */ contexts_url: string; }; @@ -28742,11 +29470,11 @@ export interface components { * @description Branch protections protect branches */ "protected-branch": { - /** Format: uri */ + /** @format uri */ url: string; required_status_checks?: components["schemas"]["status-check-policy"]; required_pull_request_reviews?: { - /** Format: uri */ + /** @format uri */ url: string; dismiss_stale_reviews?: boolean; require_code_owner_reviews?: boolean; @@ -28757,11 +29485,11 @@ export interface components { */ require_last_push_approval: boolean; dismissal_restrictions?: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ users_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; users: components["schemas"]["simple-user"][]; teams: components["schemas"]["team"][]; @@ -28775,15 +29503,15 @@ export interface components { }; required_signatures?: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + * @format uri */ url: string; /** @example true */ enabled: boolean; }; enforce_admins?: { - /** Format: uri */ + /** @format uri */ url: string; enabled: boolean; }; @@ -28820,8 +29548,8 @@ export interface components { */ "deployment-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 + * @format uri */ url: string; /** @@ -28843,26 +29571,29 @@ export interface components { * @example production */ environment: string; - /** @example Deploy request from hubot */ + /** + * @nullable + * @example Deploy request from hubot + */ description: string | null; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + * @format uri */ statuses_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** @@ -28883,9 +29614,9 @@ export interface components { */ "check-run": { /** - * Format: int64 * @description The id of the check. * @example 21 + * @format int64 */ id: number; /** @@ -28895,13 +29626,22 @@ export interface components { head_sha: string; /** @example MDg6Q2hlY2tSdW40 */ node_id: string; - /** @example 42 */ + /** + * @nullable + * @example 42 + */ external_id: string | null; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ url: string; - /** @example https://github.com/github/hello-world/runs/4 */ + /** + * @nullable + * @example https://github.com/github/hello-world/runs/4 + */ html_url: string | null; - /** @example https://example.com */ + /** + * @nullable + * @example https://example.com + */ details_url: string | null; /** * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. @@ -28910,26 +29650,32 @@ export interface components { */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ started_at: string | null; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ completed_at: string | null; output: { + /** @nullable */ title: string | null; + /** @nullable */ summary: string | null; + /** @nullable */ text: string | null; annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; }; /** @@ -28937,6 +29683,7 @@ export interface components { * @example test-coverage */ name: string; + /** @nullable */ check_suite: { id: number; } | null; @@ -28956,17 +29703,35 @@ export interface components { start_line: number; /** @example 2 */ end_line: number; - /** @example 5 */ + /** + * @nullable + * @example 5 + */ start_column: number | null; - /** @example 10 */ + /** + * @nullable + * @example 10 + */ end_column: number | null; - /** @example warning */ + /** + * @nullable + * @example warning + */ annotation_level: string | null; - /** @example Spell Checker */ + /** + * @nullable + * @example Spell Checker + */ title: string | null; - /** @example Check your spelling for 'banaas'. */ + /** + * @nullable + * @example Check your spelling for 'banaas'. + */ message: string | null; - /** @example Do you mean 'bananas' or 'banana'? */ + /** + * @nullable + * @example Do you mean 'bananas' or 'banana'? + */ raw_details: string | null; blob_href: string; }; @@ -28988,12 +29753,15 @@ export interface components { */ message: string; /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ timestamp: string; - /** @description Information about the Git author */ + /** + * @nullable + * @description Information about the Git author + */ author: { /** * @description Name of the commit's author @@ -29001,13 +29769,16 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; - /** @description Information about the Git committer */ + /** + * @nullable + * @description Information about the Git committer + */ committer: { /** * @description Name of the commit's committer @@ -29015,9 +29786,9 @@ export interface components { */ name: string; /** - * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com + * @format email */ email: string; } | null; @@ -29028,13 +29799,16 @@ export interface components { */ "check-suite": { /** - * Format: int64 * @example 5 + * @format int64 */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that is being checked. @@ -29042,28 +29816,46 @@ export interface components { */ head_sha: string; /** + * @nullable * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; - /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ + /** + * @nullable + * @example https://api.github.com/repos/github/hello-world/check-suites/5 + */ url: string | null; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ before: string | null; - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ after: string | null; + /** @nullable */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; app: components["schemas"]["nullable-integration"]; repository: components["schemas"]["minimal-repository"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; head_commit: components["schemas"]["simple-commit"]; latest_check_runs_count: number; @@ -29102,16 +29894,21 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; "code-scanning-alert-rule": { - /** @description A unique identifier for the rule used to detect the alert. */ + /** + * @nullable + * @description A unique identifier for the rule used to detect the alert. + */ id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity?: "none" | "note" | "warning" | "error" | null; /** + * @nullable * @description The security severity of the alert. * @enum {string|null} */ @@ -29120,11 +29917,20 @@ export interface components { description?: string; /** @description A description of the rule used to detect the alert. */ full_description?: string; - /** @description A set of tags applicable for the rule. */ + /** + * @nullable + * @description A set of tags applicable for the rule. + */ tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + /** + * @nullable + * @description Detailed documentation for the rule as GitHub Flavored Markdown. + */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; }; "code-scanning-alert": { @@ -29154,11 +29960,14 @@ export interface components { * @enum {string} */ "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; - /** @description The description of an autofix. */ + /** + * @nullable + * @description The description of an autofix. + */ "code-scanning-autofix-description": string | null; /** - * Format: date-time * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-autofix-started-at": string; "code-scanning-autofix": { @@ -29166,7 +29975,10 @@ export interface components { description: components["schemas"]["code-scanning-autofix-description"]; started_at: components["schemas"]["code-scanning-autofix-started-at"]; }; - /** @description Commit an autofix for a code scanning alert */ + /** + * @nullable + * @description Commit an autofix for a code scanning alert + */ "code-scanning-autofix-commits": { /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ target_ref?: string; @@ -29184,18 +29996,21 @@ export interface components { * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ "code-scanning-analysis-sarif-id": string; - /** @description The SHA of the commit to which the analysis you are uploading relates. */ + /** + * @description The SHA of the commit to which the analysis you are uploading relates. + * @pattern ^[0-9a-fA-F]+$ + */ "code-scanning-analysis-commit-sha": string; /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ "code-scanning-analysis-environment": string; /** - * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-analysis-created-at": string; /** - * Format: uri * @description The REST API URL of the analysis resource. + * @format uri */ "code-scanning-analysis-url": string; "code-scanning-analysis": { @@ -29229,13 +30044,15 @@ export interface components { */ "code-scanning-analysis-deletion": { /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, without last analysis deletion confirmation + * @format uri */ readonly next_analysis_url: string | null; /** - * Format: uri + * @nullable * @description Next deletable analysis in chain, with last analysis deletion confirmation + * @format uri */ readonly confirm_delete_url: string | null; }; @@ -29256,21 +30073,24 @@ export interface components { /** @description The size of the CodeQL database file in bytes. */ size: number; /** - * Format: date-time * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** - * Format: uri * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. + * @format uri */ url: string; - /** @description The commit SHA of the repository at the time the CodeQL database was created. */ + /** + * @nullable + * @description The commit SHA of the repository at the time the CodeQL database was created. + */ commit_oid?: string | null; }; /** @@ -29303,8 +30123,9 @@ export interface components { /** @example 80 */ stargazers_count: number; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; }; @@ -29335,18 +30156,19 @@ export interface components { /** @description The download url for the query pack. */ query_pack_url: string; /** - * Format: date-time * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at?: string; /** - * Format: date-time * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at?: string; /** - * Format: date-time + * @nullable * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + * @format date-time */ completed_at?: string | null; /** @enum {string} */ @@ -29410,11 +30232,13 @@ export interface components { /** @description Languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** + * @nullable * @description Runner type to be used. * @enum {string|null} */ runner_type?: "standard" | "labeled" | null; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29425,12 +30249,14 @@ export interface components { */ query_suite?: "default" | "extended"; /** - * Format: date-time + * @nullable * @description Timestamp of latest configuration update. * @example 2023-12-06T14:20:20.000Z + * @format date-time */ updated_at?: string | null; /** + * @nullable * @description The frequency of the periodic analysis. * @enum {string|null} */ @@ -29449,6 +30275,7 @@ export interface components { */ runner_type?: "standard" | "labeled"; /** + * @nullable * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ @@ -29475,6 +30302,7 @@ export interface components { * @description The full Git reference, formatted as `refs/heads/`, * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main + * @pattern ^refs/(heads|tags|pull)/.*$ */ "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)." */ @@ -29482,8 +30310,8 @@ export interface components { "code-scanning-sarifs-receipt": { id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** - * Format: uri * @description The REST API URL for checking the status of the upload. + * @format uri */ readonly url?: string; }; @@ -29494,11 +30322,15 @@ export interface components { */ processing_status?: "pending" | "complete" | "failed"; /** - * Format: uri + * @nullable * @description The REST API URL for getting the analyses associated with the upload. + * @format uri */ readonly analyses_url?: string | null; - /** @description Any errors that ocurred during processing of the delivery. */ + /** + * @nullable + * @description Any errors that ocurred during processing of the delivery. + */ readonly errors?: string[] | null; }; /** @description Code security configuration associated with a repository and attachment status */ @@ -29537,6 +30369,7 @@ export interface components { */ kind: string; /** + * @nullable * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. * @example The pattern `/` will never match anything, did you mean `*` instead? */ @@ -29592,6 +30425,7 @@ export interface components { */ cpus: number; /** + * @nullable * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} @@ -29619,9 +30453,9 @@ export interface components { * @example SECRET_TOKEN */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -29632,34 +30466,39 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29669,25 +30508,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -29711,9 +30550,9 @@ export interface components { */ "repository-invitation": { /** - * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 + * @format int64 */ id: number; repository: components["schemas"]["minimal-repository"]; @@ -29726,8 +30565,8 @@ export interface components { */ permissions: "read" | "write" | "admin" | "triage" | "maintain"; /** - * Format: date-time * @example 2016-06-13T14:52:50-05:00 + * @format date-time */ created_at: string; /** @description Whether or not the invitation has expired */ @@ -29743,40 +30582,46 @@ export interface components { }; /** * Collaborator + * @nullable * @description Collaborator */ "nullable-collaborator": { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -29786,25 +30631,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -29837,21 +30682,24 @@ export interface components { * @description Commit Comment */ "commit-comment": { - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ url: string; id: number; node_id: string; body: string; + /** @nullable */ path: string | null; + /** @nullable */ position: number | null; + /** @nullable */ line: number | null; commit_id: string; user: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -29877,6 +30725,7 @@ export interface components { }; /** * Auto merge + * @nullable * @description The status of auto merging a pull request. */ "auto-merge": { @@ -29897,57 +30746,57 @@ export interface components { */ "pull-request-simple": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ statuses_url: string; /** @example 1347 */ @@ -29959,10 +30808,13 @@ export interface components { /** @example new-feature */ title: string; user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; @@ -29972,33 +30824,44 @@ export interface components { default: boolean; }[]; milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ merge_commit_sha: string | null; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_reviewers?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_teams?: components["schemas"]["team"][] | null; head: { label: string; @@ -30034,21 +30897,29 @@ export interface components { }; /** Simple Commit Status */ "simple-commit-status": { + /** @nullable */ description: string | null; id: number; node_id: string; state: string; context: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ target_url: string | null; + /** @nullable */ required?: boolean | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ avatar_url: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30061,9 +30932,9 @@ export interface components { sha: string; total_count: number; repository: components["schemas"]["minimal-repository"]; - /** Format: uri */ + /** @format uri */ commit_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -30072,11 +30943,14 @@ export interface components { */ status: { url: string; + /** @nullable */ avatar_url: string | null; id: number; node_id: string; state: string; + /** @nullable */ description: string | null; + /** @nullable */ target_url: string | null; context: string; created_at: string; @@ -30085,12 +30959,13 @@ export interface components { }; /** * Code Of Conduct Simple + * @nullable * @description Code of Conduct Simple */ "nullable-code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ url: string; /** @example citizen_code_of_conduct */ @@ -30098,16 +30973,20 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ html_url: string | null; } | null; - /** Community Health File */ + /** + * Community Health File + * @nullable + */ "nullable-community-health-file": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; } | null; /** @@ -30117,9 +30996,15 @@ export interface components { "community-profile": { /** @example 100 */ health_percentage: number; - /** @example My first repository on GitHub! */ + /** + * @nullable + * @example My first repository on GitHub! + */ description: string | null; - /** @example example.com */ + /** + * @nullable + * @example example.com + */ documentation: string | null; files: { code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; @@ -30131,8 +31016,9 @@ export interface components { pull_request_template: components["schemas"]["nullable-community-health-file"]; }; /** - * Format: date-time + * @nullable * @example 2017-02-28T19:09:29Z + * @format date-time */ updated_at: string | null; /** @example true */ @@ -30144,28 +31030,28 @@ export interface components { */ "commit-comparison": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + * @format uri */ permalink_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch + * @format uri */ patch_url: string; base_commit: components["schemas"]["commit"]; @@ -30195,13 +31081,22 @@ export interface components { path: string; sha: string; content?: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; entries?: { type: string; @@ -30209,29 +31104,50 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30247,20 +31163,35 @@ export interface components { path: string; content?: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }[]; @@ -30280,20 +31211,35 @@ export interface components { path: string; content: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; /** @example "actual/actual.md" */ @@ -30316,20 +31262,35 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30343,26 +31304,41 @@ export interface components { * @enum {string} */ type: "submodule"; - /** Format: uri */ + /** @format uri */ submodule_git_url: string; size: number; name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; }; @@ -30371,6 +31347,7 @@ export interface components { * @description File Commit */ "file-commit": { + /** @nullable */ content: { name?: string; path?: string; @@ -30415,8 +31392,11 @@ export interface components { verification?: { verified?: boolean; reason?: string; + /** @nullable */ signature?: string | null; + /** @nullable */ payload?: string | null; + /** @nullable */ verified_at?: string | null; }; }; @@ -30445,26 +31425,27 @@ export interface components { login?: string; id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ avatar_url?: string; + /** @nullable */ gravatar_id?: string | null; - /** Format: uri */ + /** @format uri */ url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; following_url?: string; gists_url?: string; starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; events_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; type: string; site_admin?: boolean; @@ -30487,6 +31468,7 @@ export interface components { /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** + * @nullable * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ @@ -30501,11 +31483,15 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_by: components["schemas"]["nullable-simple-user"]; /** + * @nullable * @description The reason that the alert was dismissed. * @enum {string|null} */ dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; - /** @description An optional comment associated with the alert's dismissal. */ + /** + * @nullable + * @description An optional comment associated with the alert's dismissal. + */ dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; @@ -30520,9 +31506,9 @@ export interface components { * @example MY_ARTIFACTORY_PASSWORD */ name: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -30540,11 +31526,20 @@ export interface components { name: string; /** @example 1.0.0 */ version: string; - /** @example pkg:/npm/%40actions/core@1.1.0 */ + /** + * @nullable + * @example pkg:/npm/%40actions/core@1.1.0 + */ package_url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ license: string | null; - /** @example https://github.com/github/actions */ + /** + * @nullable + * @example https://github.com/github/actions + */ source_repository_url: string | null; vulnerabilities: { /** @example critical */ @@ -30699,6 +31694,7 @@ export interface components { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. * @example pkg:/npm/%40actions/http-client@1.0.11 + * @pattern ^pkg */ package_url?: string; metadata?: components["schemas"]["metadata"]; @@ -30771,6 +31767,7 @@ export interface components { /** * @description The repository branch that triggered this snapshot. * @example refs/heads/main + * @pattern ^refs/ */ ref: string; /** @description A description of the detector used. */ @@ -30797,9 +31794,9 @@ export interface components { [key: string]: components["schemas"]["manifest"]; }; /** - * Format: date-time * @description The time at which the snapshot was scanned. * @example 2020-06-13T14:52:50-05:00 + * @format date-time */ scanned: string; }; @@ -30809,13 +31806,13 @@ export interface components { */ "deployment-status": { /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ @@ -30840,44 +31837,44 @@ export interface components { */ environment: string; /** - * Format: uri * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ target_url: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2012-07-20T01:19:13Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 + * @format uri */ deployment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; /** - * Format: uri * @description The URL for accessing your environment. * @default * @example https://staging.example.com/ + * @format uri */ environment_url: string; /** - * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output + * @format uri */ log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -30887,7 +31884,10 @@ export interface components { * @example 30 */ "wait-timer": number; - /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ + /** + * @nullable + * @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. + */ "deployment-branch-policy-settings": { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ protected_branches: boolean; @@ -30900,9 +31900,9 @@ export interface components { */ environment: { /** - * Format: int64 * @description The id of the environment. * @example 56780428 + * @format int64 */ id: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ @@ -30917,15 +31917,15 @@ export interface components { /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ html_url: string; /** - * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z + * @format date-time */ updated_at: string; /** @description Built-in deployment protection rules for the environment. */ @@ -31084,9 +32084,10 @@ export interface components { blob: { content: string; encoding: string; - /** Format: uri */ + /** @format uri */ url: string; sha: string; + /** @nullable */ size: number | null; node_id: string; highlighted_content?: string; @@ -31102,14 +32103,14 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -31126,9 +32127,9 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -31153,7 +32154,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -31162,19 +32163,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { verified: boolean; reason: string; + /** @nullable */ signature: string | null; + /** @nullable */ payload: string | null; + /** @nullable */ verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -31184,7 +32188,7 @@ export interface components { "git-ref": { ref: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; object: { type: string; @@ -31193,7 +32197,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; }; @@ -31212,9 +32216,9 @@ export interface components { /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ sha: string; /** - * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + * @format uri */ url: string; /** @@ -31230,7 +32234,7 @@ export interface components { object: { sha: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; }; verification?: components["schemas"]["verification"]; @@ -31241,7 +32245,7 @@ export interface components { */ "git-tree": { sha: string; - /** Format: uri */ + /** @format uri */ url: string; truncated: boolean; /** @@ -31302,8 +32306,11 @@ export interface components { }; /** Hook Response */ "hook-response": { + /** @nullable */ code: number | null; + /** @nullable */ status: string | null; + /** @nullable */ message: string | null; }; /** @@ -31337,33 +32344,33 @@ export interface components { events: string[]; config: components["schemas"]["webhook-config"]; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test + * @format uri */ test_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + * @format uri */ ping_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries + * @format uri */ deliveries_url?: string; last_response: components["schemas"]["hook-response"]; @@ -31373,6 +32380,7 @@ export interface components { * @description A repository import from an external source. */ import: { + /** @nullable */ vcs: string | null; use_lfs?: boolean; /** @description The URL of the originating repository. */ @@ -31381,11 +32389,17 @@ export interface components { tfvc_project?: string; /** @enum {string} */ status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; + /** @nullable */ status_text?: string | null; + /** @nullable */ failed_step?: string | null; + /** @nullable */ error_message?: string | null; + /** @nullable */ import_percent?: number | null; + /** @nullable */ commit_count?: number | null; + /** @nullable */ push_percent?: number | null; has_large_files?: boolean; large_files_size?: number; @@ -31396,14 +32410,15 @@ export interface components { human_name?: string; }[]; message?: string; + /** @nullable */ authors_count?: number | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ authors_url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; svn_root?: string; }; @@ -31417,9 +32432,9 @@ export interface components { remote_name: string; email: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ import_url: string; }; /** @@ -31434,26 +32449,27 @@ export interface components { }; /** * Issue + * @nullable * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ "nullable-issue": { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; /** - * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 + * @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** * @description Number uniquely identifying the issue within its repository @@ -31466,6 +32482,7 @@ export interface components { */ state: string; /** + * @nullable * @description The reason for the current state * @example not_planned * @enum {string|null} @@ -31477,6 +32494,7 @@ export interface components { */ title: string; /** + * @nullable * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ @@ -31490,45 +32508,67 @@ export interface components { * ] */ labels: (string | { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; - /** Format: uri */ + /** @format uri */ url?: string; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; default?: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; comments: number; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; draft?: boolean; closed_by?: components["schemas"]["nullable-simple-user"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -31541,14 +32581,18 @@ export interface components { * @description Issue Event Label */ "issue-event-label": { + /** @nullable */ name: string | null; + /** @nullable */ color: string | null; }; /** Issue Event Dismissed Review */ "issue-event-dismissed-review": { state: string; review_id: number; + /** @nullable */ dismissal_message: string | null; + /** @nullable */ dismissal_commit_id?: string | null; }; /** @@ -31563,10 +32607,10 @@ export interface components { * @description Issue Event Project Card */ "issue-event-project-card": { - /** Format: uri */ + /** @format uri */ url: string; id: number; - /** Format: uri */ + /** @format uri */ project_url: string; project_id: number; column_name: string; @@ -31586,27 +32630,33 @@ export interface components { */ "issue-event": { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDEwOklzc3VlRXZlbnQx */ node_id: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 + * @format uri */ url: string; actor: components["schemas"]["nullable-simple-user"]; /** @example closed */ event: string; - /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e + */ commit_id: string | null; - /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ + /** + * @nullable + * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ commit_url: string | null; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; issue?: components["schemas"]["nullable-issue"]; @@ -31621,6 +32671,7 @@ export interface components { project_card?: components["schemas"]["issue-event-project-card"]; rename?: components["schemas"]["issue-event-rename"]; author_association?: components["schemas"]["author-association"]; + /** @nullable */ lock_reason?: string | null; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; @@ -31634,7 +32685,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31653,7 +32706,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31672,7 +32727,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["integration"]; @@ -31689,7 +32746,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31706,7 +32765,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31724,7 +32785,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31742,7 +32805,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31761,7 +32826,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31779,7 +32846,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -31797,13 +32866,16 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; dismissed_review: { state: string; review_id: number; + /** @nullable */ dismissal_message: string | null; dismissal_commit_id?: string; }; @@ -31818,11 +32890,16 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; - /** @example "off-topic" */ + /** + * @nullable + * @example "off-topic" + */ lock_reason: string | null; }; /** @@ -31835,16 +32912,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31860,16 +32939,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31885,16 +32966,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31910,16 +32993,18 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["integration"]; project_card?: { id: number; - /** Format: uri */ + /** @format uri */ url: string; project_id: number; - /** Format: uri */ + /** @format uri */ project_url: string; column_name: string; previous_column_name?: string; @@ -31936,17 +33021,17 @@ export interface components { */ label: { /** - * Format: int64 * @description Unique identifier for the label. * @example 208045946 + * @format int64 */ id: number; /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ node_id: string; /** - * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug + * @format uri */ url: string; /** @@ -31955,6 +33040,7 @@ export interface components { */ name: string; /** + * @nullable * @description Optional description of the label, such as its purpose. * @example Something isn't working */ @@ -31984,9 +33070,9 @@ export interface components { id: number; node_id: string; /** - * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 + * @format uri */ url: string; /** @@ -31996,20 +33082,20 @@ export interface components { body?: string; body_text?: string; body_html?: string; - /** Format: uri */ + /** @format uri */ html_url: string; user: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ issue_url: string; author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; @@ -32022,9 +33108,9 @@ export interface components { "timeline-cross-referenced-event": { event: string; actor?: components["schemas"]["simple-user"]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; source: { type?: string; @@ -32043,14 +33129,14 @@ export interface components { */ sha: string; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; /** @description Identifying information for the git-user */ author: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -32067,9 +33153,9 @@ export interface components { /** @description Identifying information for the git-user */ committer: { /** - * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 + * @format date-time */ date: string; /** @@ -32094,7 +33180,7 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; parents: { @@ -32103,19 +33189,22 @@ export interface components { * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; }[]; verification: { verified: boolean; reason: string; + /** @nullable */ signature: string | null; + /** @nullable */ payload: string | null; + /** @nullable */ verified_at?: string | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; }; /** @@ -32133,6 +33222,7 @@ export interface components { node_id: string; user: components["schemas"]["simple-user"]; /** + * @nullable * @description The text of the review. * @example This looks great. */ @@ -32140,13 +33230,13 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ pull_request_url: string; _links: { @@ -32157,7 +33247,7 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** * @description A commit SHA for the review. @@ -32179,15 +33269,16 @@ export interface components { */ url: string; /** - * Format: int64 + * @nullable * @description The ID of the pull request review to which the comment belongs. * @example 42 + * @format int64 */ pull_request_review_id: number | null; /** - * Format: int64 * @description The ID of the pull request review comment. * @example 1 + * @format int64 */ id: number; /** @@ -32237,62 +33328,65 @@ export interface components { */ body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; /** - * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ html_url: string; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ pull_request_url: string; author_association: components["schemas"]["author-association"]; _links: { self: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ href: string; }; html: { /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ href: string; }; pull_request: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ href: string; }; }; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ start_line?: number | null; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ original_start_line?: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -32354,7 +33448,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32370,7 +33466,9 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -32386,10 +33484,13 @@ export interface components { url: string; actor: components["schemas"]["simple-user"]; event: string; + /** @nullable */ commit_id: string | null; + /** @nullable */ commit_url: string | null; created_at: string; performed_via_github_app: components["schemas"]["nullable-integration"]; + /** @nullable */ state_reason?: string | null; }; /** @@ -32409,7 +33510,9 @@ export interface components { verified: boolean; created_at: string; read_only: boolean; + /** @nullable */ added_by?: string | null; + /** @nullable */ last_used?: string | null; enabled?: boolean; }; @@ -32429,23 +33532,38 @@ export interface components { path: string; sha: string; size: number; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ git_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ download_url: string | null; type: string; content: string; encoding: string; _links: { - /** Format: uri */ + /** + * @nullable + * @format uri + */ git: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html: string | null; - /** Format: uri */ + /** @format uri */ self: string; }; license: components["schemas"]["nullable-license-simple"]; @@ -32466,18 +33584,18 @@ export interface components { */ milestone: { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + * @format uri */ labels_url: string; /** @example 1002604 */ @@ -32501,7 +33619,10 @@ export interface components { * @example v1.0 */ title: string; - /** @example Tracking milestone for version 1.0 */ + /** + * @nullable + * @example Tracking milestone for version 1.0 + */ description: string | null; creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ @@ -32509,23 +33630,25 @@ export interface components { /** @example 8 */ closed_issues: number; /** - * Format: date-time * @example 2011-04-10T20:09:31Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2014-03-03T18:58:10Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2013-02-12T13:22:01Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2012-10-09T23:39:01Z + * @format date-time */ due_on: string | null; }; @@ -32551,7 +33674,7 @@ export interface components { * ] */ domains: string[]; - /** Format: date */ + /** @format date */ expires_at?: string; }; /** @@ -32560,31 +33683,35 @@ export interface components { */ page: { /** - * Format: uri * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages + * @format uri */ url: string; /** + * @nullable * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ status: "built" | "building" | "errored" | null; /** + * @nullable * @description The Pages site's custom domain * @example example.com */ cname: string | null; /** + * @nullable * @description The state if the domain is verified * @example pending * @enum {string|null} */ protected_domain_state?: "pending" | "verified" | "unverified" | null; /** - * Format: date-time + * @nullable * @description The timestamp when a pending domain becomes unverified. + * @format date-time */ pending_domain_unverified_at?: string | null; /** @@ -32594,12 +33721,13 @@ export interface components { */ custom_404: boolean; /** - * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com + * @format uri */ html_url?: string; /** + * @nullable * @description The process in which the Page will be built. * @example legacy * @enum {string|null} @@ -32623,18 +33751,19 @@ export interface components { * @description Page Build */ "page-build": { - /** Format: uri */ + /** @format uri */ url: string; status: string; error: { + /** @nullable */ message: string | null; }; pusher: components["schemas"]["nullable-simple-user"]; commit: string; duration: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -32643,8 +33772,8 @@ export interface components { */ "page-build-status": { /** - * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest + * @format uri */ url: string; /** @example queued */ @@ -32658,21 +33787,21 @@ export interface components { /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ id: number | string; /** - * Format: uri * @description The URI to monitor GitHub Pages deployment status. * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 + * @format uri */ status_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages. * @example hello-world.github.io + * @format uri */ page_url: string; /** - * Format: uri * @description The URI to the deployed GitHub Pages preview. * @example monalisa-1231a2312sa32-23sda74.drafts.github.io + * @format uri */ preview_url?: string; }; @@ -32694,59 +33823,96 @@ export interface components { uri?: string; nameservers?: string; dns_resolves?: boolean; + /** @nullable */ is_proxied?: boolean | null; + /** @nullable */ is_cloudflare_ip?: boolean | null; + /** @nullable */ is_fastly_ip?: boolean | null; + /** @nullable */ is_old_ip_address?: boolean | null; + /** @nullable */ is_a_record?: boolean | null; + /** @nullable */ has_cname_record?: boolean | null; + /** @nullable */ has_mx_records_present?: boolean | null; is_valid_domain?: boolean; is_apex_domain?: boolean; + /** @nullable */ should_be_a_record?: boolean | null; + /** @nullable */ is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ is_cname_to_fastly?: boolean | null; + /** @nullable */ is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ is_non_github_pages_ip_present?: boolean | null; is_pages_domain?: boolean; + /** @nullable */ is_served_by_pages?: boolean | null; is_valid?: boolean; + /** @nullable */ reason?: string | null; responds_to_https?: boolean; enforces_https?: boolean; + /** @nullable */ https_error?: string | null; + /** @nullable */ is_https_eligible?: boolean | null; + /** @nullable */ caa_error?: string | null; }; + /** @nullable */ alt_domain?: { host?: string; uri?: string; nameservers?: string; dns_resolves?: boolean; + /** @nullable */ is_proxied?: boolean | null; + /** @nullable */ is_cloudflare_ip?: boolean | null; + /** @nullable */ is_fastly_ip?: boolean | null; + /** @nullable */ is_old_ip_address?: boolean | null; + /** @nullable */ is_a_record?: boolean | null; + /** @nullable */ has_cname_record?: boolean | null; + /** @nullable */ has_mx_records_present?: boolean | null; is_valid_domain?: boolean; is_apex_domain?: boolean; + /** @nullable */ should_be_a_record?: boolean | null; + /** @nullable */ is_cname_to_github_user_domain?: boolean | null; + /** @nullable */ is_cname_to_pages_dot_github_dot_com?: boolean | null; + /** @nullable */ is_cname_to_fastly?: boolean | null; + /** @nullable */ is_pointed_to_github_pages_ip?: boolean | null; + /** @nullable */ is_non_github_pages_ip_present?: boolean | null; is_pages_domain?: boolean; + /** @nullable */ is_served_by_pages?: boolean | null; is_valid?: boolean; + /** @nullable */ reason?: string | null; responds_to_https?: boolean; enforces_https?: boolean; + /** @nullable */ https_error?: string | null; + /** @nullable */ is_https_eligible?: boolean | null; + /** @nullable */ caa_error?: string | null; } | null; }; @@ -32756,57 +33922,57 @@ export interface components { */ "pull-request": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + * @format uri */ url: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 + * @format uri */ html_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff + * @format uri */ diff_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch + * @format uri */ patch_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + * @format uri */ commits_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + * @format uri */ review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ review_comment_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + * @format uri */ comments_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + * @format uri */ statuses_url: string; /** @@ -32828,46 +33994,61 @@ export interface components { */ title: string; user: components["schemas"]["simple-user"]; - /** @example Please pull these awesome changes */ + /** + * @nullable + * @example Please pull these awesome changes + */ body: string | null; labels: { - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; url: string; name: string; + /** @nullable */ description: string | null; color: string; default: boolean; }[]; milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ + /** + * @nullable + * @example too heated + */ active_lock_reason?: string | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + /** + * @nullable + * @example e5bd3914e2e596debea16f433f57875b5b90bcd6 + */ merge_commit_sha: string | null; assignee: components["schemas"]["nullable-simple-user"]; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_reviewers?: components["schemas"]["simple-user"][] | null; + /** @nullable */ requested_teams?: components["schemas"]["team-simple"][] | null; head: { label: string; @@ -32901,9 +34082,15 @@ export interface components { */ draft?: boolean; merged: boolean; - /** @example true */ + /** + * @nullable + * @example true + */ mergeable: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ rebaseable?: boolean | null; /** @example clean */ mergeable_state: string; @@ -32949,9 +34136,9 @@ export interface components { */ "pull-request-review": { /** - * Format: int64 * @description Unique identifier of the review * @example 42 + * @format int64 */ id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ @@ -32965,13 +34152,13 @@ export interface components { /** @example CHANGES_REQUESTED */ state: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 + * @format uri */ pull_request_url: string; _links: { @@ -32982,9 +34169,10 @@ export interface components { href: string; }; }; - /** Format: date-time */ + /** @format date-time */ submitted_at?: string; /** + * @nullable * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ @@ -32999,18 +34187,19 @@ export interface components { */ "review-comment": { /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + * @format uri */ url: string; /** - * Format: int64 + * @nullable * @example 42 + * @format int64 */ pull_request_review_id: number | null; /** - * Format: int64 * @example 10 + * @format int64 */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ @@ -33019,7 +34208,10 @@ export interface components { diff_hunk: string; /** @example file1.txt */ path: string; - /** @example 1 */ + /** + * @nullable + * @example 1 + */ position: number | null; /** @example 4 */ original_position: number; @@ -33033,23 +34225,23 @@ export interface components { /** @example Great stuff */ body: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-04-14T16:00:49Z + * @format date-time */ updated_at: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 + * @format uri */ pull_request_url: string; author_association: components["schemas"]["author-association"]; @@ -33068,6 +34260,7 @@ export interface components { */ side: "LEFT" | "RIGHT"; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -33084,11 +34277,13 @@ export interface components { */ original_line?: number; /** + * @nullable * @description The first line of the range for a multi-line comment. * @example 2 */ start_line?: number | null; /** + * @nullable * @description The original first line of the range for a multi-line comment. * @example 2 */ @@ -33099,9 +34294,9 @@ export interface components { * @description Data related to a release. */ "release-asset": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ browser_download_url: string; id: number; node_id: string; @@ -33110,6 +34305,7 @@ export interface components { * @example Team Environment */ name: string; + /** @nullable */ label: string | null; /** * @description State of the release asset. @@ -33119,9 +34315,9 @@ export interface components { content_type: string; size: number; download_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; uploader: components["schemas"]["nullable-simple-user"]; }; @@ -33130,16 +34326,22 @@ export interface components { * @description A release. */ release: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ assets_url: string; upload_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; id: number; node_id: string; @@ -33153,7 +34355,9 @@ export interface components { * @example master */ target_commitish: string; + /** @nullable */ name: string | null; + /** @nullable */ body?: string | null; /** * @description true to create a draft (unpublished) release, false to create a published one. @@ -33165,9 +34369,12 @@ export interface components { * @example false */ prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; author: components["schemas"]["simple-user"]; assets: components["schemas"]["release-asset"][]; @@ -33175,8 +34382,8 @@ export interface components { body_text?: string; mentions_count?: number; /** - * Format: uri * @description The URL of the release discussion. + * @format uri */ discussion_url?: string; reactions?: components["schemas"]["reaction-rollup"]; @@ -33221,19 +34428,23 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; @@ -33244,22 +34455,33 @@ export interface components { secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; /** @@ -33267,12 +34489,21 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. + */ multi_repo?: boolean | null; }; - /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ + /** + * @nullable + * @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; /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ "secret-scanning-location-commit": { @@ -33343,99 +34574,99 @@ export interface components { /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_title_url: string; }; /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ "secret-scanning-location-issue-body": { /** - * Format: uri * @description The API URL to get the issue where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + * @format uri */ issue_body_url: string; }; /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ "secret-scanning-location-issue-comment": { /** - * Format: uri * @description The API URL to get the issue comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ issue_comment_url: string; }; /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ "secret-scanning-location-discussion-title": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082 + * @format uri */ discussion_title_url: string; }; /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ "secret-scanning-location-discussion-body": { /** - * Format: uri * @description The URL to the discussion where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussion-4566270 + * @format uri */ discussion_body_url: string; }; /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ "secret-scanning-location-discussion-comment": { /** - * Format: uri * @description The API URL to get the discussion comment where the secret was detected. * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + * @format uri */ discussion_comment_url: string; }; /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ "secret-scanning-location-pull-request-title": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ pull_request_title_url: string; }; /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ "secret-scanning-location-pull-request-body": { /** - * Format: uri * @description The API URL to get the pull request where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + * @format uri */ pull_request_body_url: string; }; /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ "secret-scanning-location-pull-request-comment": { /** - * Format: uri * @description The API URL to get the pull request comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + * @format uri */ pull_request_comment_url: string; }; /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ "secret-scanning-location-pull-request-review": { /** - * Format: uri * @description The API URL to get the pull request review where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + * @format uri */ pull_request_review_url: string; }; /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ "secret-scanning-location-pull-request-review-comment": { /** - * Format: uri * @description The API URL to get the pull request review comment where the secret was detected. * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + * @format uri */ pull_request_review_comment_url: string; }; @@ -33456,8 +34687,9 @@ export interface components { "secret-scanning-push-protection-bypass": { reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** - * Format: date-time + * @nullable * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ expire_at?: string | null; /** @description The token type this bypass is for. */ @@ -33470,13 +34702,15 @@ export interface components { /** @description The state of the scan. Either "completed", "running", or "pending" */ status?: string; /** - * Format: date-time + * @nullable * @description The time that the scan was completed. Empty if the scan is running + * @format date-time */ completed_at?: string | null; /** - * Format: date-time + * @nullable * @description The time that the scan was started. Empty if the scan is pending + * @format date-time */ started_at?: string | null; }; @@ -33496,37 +34730,62 @@ export interface components { summary: string; /** @description A detailed description of what the advisory impacts. */ description: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ vulnerabilities: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ credits?: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33539,29 +34798,51 @@ export interface components { summary: string; /** @description A detailed description of what the advisory impacts. */ description: string; - /** @description An array of products affected by the vulnerability detailed in a repository security advisory. */ + /** + * @nullable + * @description An array of products affected by the vulnerability detailed in a repository security advisory. + */ vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[] | null; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. @@ -33574,46 +34855,77 @@ export interface components { summary?: string; /** @description A detailed description of what the advisory impacts. */ description?: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + /** + * @nullable + * @description The Common Vulnerabilities and Exposures (CVE) ID. + */ cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ + /** + * @nullable + * @description The unique package name within its ecosystem. + */ name?: string | null; }; - /** @description The range of the package versions affected by the vulnerability. */ + /** + * @nullable + * @description The range of the package versions affected by the vulnerability. + */ vulnerable_version_range?: string | null; - /** @description The package version(s) that resolve the vulnerability. */ + /** + * @nullable + * @description The package version(s) that resolve the vulnerability. + */ patched_versions?: string | null; - /** @description The functions in the package that are affected. */ + /** + * @nullable + * @description The functions in the package that are affected. + */ vulnerable_functions?: string[] | null; }[]; - /** @description A list of Common Weakness Enumeration (CWE) IDs. */ + /** + * @nullable + * @description A list of Common Weakness Enumeration (CWE) IDs. + */ cwe_ids?: string[] | null; - /** @description A list of users receiving credit for their participation in the security advisory. */ + /** + * @nullable + * @description A list of users receiving credit for their participation in the security advisory. + */ credits?: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** + * @nullable * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ severity?: "critical" | "high" | "medium" | "low" | null; - /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ + /** + * @nullable + * @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + */ cvss_vector_string?: string | null; /** * @description The state of the advisory. * @enum {string} */ state?: "published" | "closed" | "draft"; - /** @description A list of usernames who have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of usernames who have been granted write access to the advisory. + */ collaborating_users?: string[] | null; - /** @description A list of team slugs which have been granted write access to the advisory. */ + /** + * @nullable + * @description A list of team slugs which have been granted write access to the advisory. + */ collaborating_teams?: string[] | null; }; /** @@ -33621,7 +34933,7 @@ export interface components { * @description Stargazer */ stargazer: { - /** Format: date-time */ + /** @format date-time */ starred_at: string; user: components["schemas"]["nullable-simple-user"]; }; @@ -33694,20 +35006,21 @@ export interface components { subscribed: boolean; /** @description Determines if all notifications should be blocked from this repository. */ ignored: boolean; + /** @nullable */ reason: string | null; /** - * Format: date-time * @example 2012-10-06T21:34:12Z + * @format date-time */ created_at: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example/subscription + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/repos/octocat/example + * @format uri */ repository_url: string; }; @@ -33720,17 +35033,17 @@ export interface components { name: string; commit: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** - * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 + * @format uri */ zipball_url: string; /** - * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 + * @format uri */ tarball_url: string; node_id: string; @@ -33760,7 +35073,7 @@ export interface components { }; /** Traffic */ traffic: { - /** Format: date-time */ + /** @format date-time */ timestamp: string; uniques: number; count: number; @@ -33816,6 +35129,7 @@ export interface components { /** Search Result Text Matches */ "search-result-text-matches": { object_url?: string; + /** @nullable */ object_type?: string | null; property?: string; fragment?: string; @@ -33832,17 +35146,18 @@ export interface components { name: string; path: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ git_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; repository: components["schemas"]["minimal-repository"]; score: number; file_size?: number; + /** @nullable */ language?: string | null; - /** Format: date-time */ + /** @format date-time */ last_modified_at?: string; /** * @example [ @@ -33858,18 +35173,18 @@ export interface components { * @description Commit Search Result Item */ "commit-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { name: string; email: string; - /** Format: date-time */ + /** @format date-time */ date: string; }; committer: components["schemas"]["nullable-git-user"]; @@ -33877,10 +35192,10 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification?: components["schemas"]["verification"]; }; @@ -33901,34 +35216,37 @@ export interface components { * @description Issue Search Result Item */ "issue-search-result-item": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ repository_url: string; labels_url: string; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; number: number; title: string; locked: boolean; + /** @nullable */ active_lock_reason?: string | null; + /** @nullable */ assignees?: components["schemas"]["simple-user"][] | null; user: components["schemas"]["nullable-simple-user"]; labels: { - /** Format: int64 */ + /** @format int64 */ id?: number; node_id?: string; url?: string; name?: string; color?: string; default?: boolean; + /** @nullable */ description?: string | null; }[]; /** Sub-issues Summary */ @@ -33938,27 +35256,46 @@ export interface components { percent_completed: number; }; state: string; + /** @nullable */ state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; milestone: components["schemas"]["nullable-milestone"]; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; pull_request?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ diff_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ patch_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; body?: string; @@ -33968,7 +35305,7 @@ export interface components { repository?: components["schemas"]["repository"]; body_html?: string; body_text?: string; - /** Format: uri */ + /** @format uri */ timeline_url?: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; @@ -33980,11 +35317,12 @@ export interface components { "label-search-result-item": { id: number; node_id: string; - /** Format: uri */ + /** @format uri */ url: string; name: string; color: string; default: boolean; + /** @nullable */ description: string | null; score: number; text_matches?: components["schemas"]["search-result-text-matches"]; @@ -34000,58 +35338,63 @@ export interface components { full_name: string; owner: components["schemas"]["nullable-simple-user"]; private: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; + /** @nullable */ description: string | null; fork: boolean; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ pushed_at: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ homepage: string | null; size: number; stargazers_count: number; watchers_count: number; + /** @nullable */ language: string | null; forks_count: number; open_issues_count: number; master_branch?: string; default_branch: string; score: number; - /** Format: uri */ + /** @format uri */ forks_url: string; keys_url: string; collaborators_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; issue_events_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; assignees_url: string; branches_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; blobs_url: string; git_tags_url: string; git_refs_url: string; trees_url: string; statuses_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; commits_url: string; git_commits_url: string; @@ -34059,10 +35402,10 @@ export interface components { issue_comment_url: string; contents_url: string; compare_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; archive_url: string; - /** Format: uri */ + /** @format uri */ downloads_url: string; issues_url: string; pulls_url: string; @@ -34070,18 +35413,21 @@ export interface components { notifications_url: string; labels_url: string; releases_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; git_url: string; ssh_url: string; clone_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; forks: number; open_issues: number; watchers: number; topics?: string[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; has_issues: boolean; has_projects: boolean; @@ -34120,22 +35466,32 @@ export interface components { */ "topic-search-result-item": { name: string; + /** @nullable */ display_name: string | null; + /** @nullable */ short_description: string | null; + /** @nullable */ description: string | null; + /** @nullable */ created_by: string | null; + /** @nullable */ released: string | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; featured: boolean; curated: boolean; score: number; + /** @nullable */ repository_count?: number | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ logo_url?: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ related?: { topic_relation?: { id?: number; @@ -34144,6 +35500,7 @@ export interface components { relation_type?: string; }; }[] | null; + /** @nullable */ aliases?: { topic_relation?: { id?: number; @@ -34159,25 +35516,26 @@ export interface components { */ "user-search-result-item": { login: string; - /** Format: int64 */ + /** @format int64 */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ gravatar_id: string | null; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ followers_url: string; - /** Format: uri */ + /** @format uri */ subscriptions_url: string; - /** Format: uri */ + /** @format uri */ organizations_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ received_events_url: string; type: string; score: number; @@ -34189,21 +35547,33 @@ export interface components { public_gists?: number; followers?: number; following?: number; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; + /** @nullable */ name?: string | null; + /** @nullable */ bio?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; + /** @nullable */ location?: string | null; site_admin: boolean; + /** @nullable */ hireable?: boolean | null; text_matches?: components["schemas"]["search-result-text-matches"]; + /** @nullable */ blog?: string | null; + /** @nullable */ company?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at?: string | null; user_view_type?: string; }; @@ -34215,8 +35585,8 @@ export interface components { /** @example octocat */ login: string; /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -34227,25 +35597,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -34255,52 +35628,73 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ type: string; site_admin: boolean; - /** @example monalisa octocat */ + /** + * @nullable + * @example monalisa octocat + */ name: string | null; - /** @example GitHub */ + /** + * @nullable + * @example GitHub + */ company: string | null; - /** @example https://github.com/blog */ + /** + * @nullable + * @example https://github.com/blog + */ blog: string | null; - /** @example San Francisco */ + /** + * @nullable + * @example San Francisco + */ location: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ email: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ notification_email?: string | null; + /** @nullable */ hireable: boolean | null; - /** @example There once was... */ + /** + * @nullable + * @example There once was... + */ bio: string | null; - /** @example monalisa */ + /** + * @nullable + * @example monalisa + */ twitter_username?: string | null; /** @example 2 */ public_repos: number; @@ -34311,13 +35705,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ updated_at: string; /** @example 81 */ @@ -34352,13 +35746,13 @@ export interface components { */ name: string; /** - * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ created_at: string; /** - * Format: date-time * @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + * @format date-time */ updated_at: string; /** @@ -34367,9 +35761,9 @@ export interface components { */ visibility: "all" | "private" | "selected"; /** - * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/user/secrets/SECRET_NAME/repositories + * @format uri */ selected_repositories_url: string; }; @@ -34395,22 +35789,26 @@ export interface components { */ "codespace-export-details": { /** + * @nullable * @description State of the latest export * @example succeeded | failed | in_progress */ state?: string | null; /** - * Format: date-time + * @nullable * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z + * @format date-time */ completed_at?: string | null; /** + * @nullable * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ branch?: string | null; /** + * @nullable * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ @@ -34426,6 +35824,7 @@ export interface components { */ export_url?: string; /** + * @nullable * @description Web url for the exported branch * @example https://github.com/octocat/hello-world/tree/:branch */ @@ -34437,8 +35836,8 @@ export interface components { */ "codespace-with-full-repository": { /** - * Format: int64 * @example 1 + * @format int64 */ id: number; /** @@ -34447,11 +35846,13 @@ export interface components { */ name: string; /** + * @nullable * @description Display name for this codespace. * @example bookish space pancake */ display_name?: string | null; /** + * @nullable * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ @@ -34461,29 +35862,31 @@ export interface components { repository: components["schemas"]["full-repository"]; machine: components["schemas"]["nullable-codespace-machine"]; /** + * @nullable * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ devcontainer_path?: string | null; /** + * @nullable * @description Whether the codespace was created from a prebuild. * @example false */ prebuild: boolean | null; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ updated_at: string; /** - * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z + * @format date-time */ last_used_at: string; /** @@ -34493,8 +35896,8 @@ export interface components { */ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** - * Format: uri * @description API URL for this codespace. + * @format uri */ url: string; /** @description Details about the codespace's git repository. */ @@ -34526,60 +35929,77 @@ export interface components { */ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** + * @nullable * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ idle_timeout_minutes: number | null; /** - * Format: uri * @description URL to access this codespace on the web. + * @format uri */ web_url: string; /** - * Format: uri * @description API URL to access available alternate machine types for this codespace. + * @format uri */ machines_url: string; /** - * Format: uri * @description API URL to start this codespace. + * @format uri */ start_url: string; /** - * Format: uri * @description API URL to stop this codespace. + * @format uri */ stop_url: string; /** - * Format: uri + * @nullable * @description API URL to publish this codespace to a new repository. + * @format uri */ publish_url?: string | null; /** - * Format: uri + * @nullable * @description API URL for the Pull Request associated with this codespace, if any. + * @format uri */ pulls_url: string | null; recent_folders: string[]; runtime_constraints?: { - /** @description The privacy settings a user can select from when forwarding a port. */ + /** + * @nullable + * @description The privacy settings a user can select from when forwarding a port. + */ allowed_port_privacy_settings?: string[] | null; }; - /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ + /** + * @nullable + * @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + */ pending_operation?: boolean | null; - /** @description Text to show user when codespace is disabled by a pending operation */ + /** + * @nullable + * @description Text to show user when codespace is disabled by a pending operation + */ pending_operation_disabled_reason?: string | null; - /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ + /** + * @nullable + * @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy + */ idle_timeout_notice?: string | null; /** + * @nullable * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ retention_period_minutes?: number | null; /** - * Format: date-time + * @nullable * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z + * @format date-time */ retention_expires_at?: string | null; }; @@ -34589,15 +36009,18 @@ export interface components { */ email: { /** - * Format: email * @example octocat@github.com + * @format email */ email: string; /** @example true */ primary: boolean; /** @example true */ verified: boolean; - /** @example public */ + /** + * @nullable + * @example public + */ visibility: string | null; }; /** @@ -34606,12 +36029,16 @@ export interface components { */ "gpg-key": { /** - * Format: int64 * @example 3 + * @format int64 */ id: number; - /** @example Octocat's GPG Key */ + /** + * @nullable + * @example Octocat's GPG Key + */ name?: string | null; + /** @nullable */ primary_key_id: number | null; /** @example 3262EFF25BA0D270 */ key_id: string; @@ -34648,7 +36075,7 @@ export interface components { * ] */ subkeys: { - /** Format: int64 */ + /** @format int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -34663,7 +36090,9 @@ export interface components { can_encrypt_storage?: boolean; can_certify?: boolean; created_at?: string; + /** @nullable */ expires_at?: string | null; + /** @nullable */ raw_key?: string | null; revoked?: boolean; }[]; @@ -34674,14 +36103,18 @@ export interface components { /** @example true */ can_certify: boolean; /** - * Format: date-time * @example 2016-03-24T11:31:04-06:00 + * @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; /** @example true */ revoked: boolean; + /** @nullable */ raw_key: string | null; }; /** @@ -34690,26 +36123,32 @@ export interface components { */ key: { key: string; - /** Format: int64 */ + /** @format int64 */ id: number; url: string; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; verified: boolean; read_only: boolean; }; /** Marketplace Account */ "marketplace-account": { - /** Format: uri */ + /** @format uri */ url: string; id: number; type: string; node_id?: string; login: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; - /** Format: email */ + /** + * @nullable + * @format email + */ organization_billing_email?: string | null; }; /** @@ -34720,21 +36159,25 @@ export interface components { /** @example monthly */ billing_cycle: string; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ next_billing_date: string | null; + /** @nullable */ unit_count: number | null; /** @example true */ on_free_trial: boolean; /** - * Format: date-time + * @nullable * @example 2017-11-11T00:00:00Z + * @format date-time */ free_trial_ends_on: string | null; /** - * Format: date-time + * @nullable * @example 2017-11-02T01:12:12Z + * @format date-time */ updated_at: string | null; account: components["schemas"]["marketplace-account"]; @@ -34758,7 +36201,7 @@ export interface components { key: string; id: number; title: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; }; /** @@ -34766,7 +36209,7 @@ export interface components { * @description Starred Repository */ "starred-repository": { - /** Format: date-time */ + /** @format date-time */ starred_at: string; repo: components["schemas"]["repository"]; }; @@ -34795,9 +36238,11 @@ export interface components { inclusionPromise?: { signedEntryTimestamp?: string; }; + /** @nullable */ inclusionProof?: string | null; canonicalizedBody?: string; }[]; + /** @nullable */ timestampVerificationData?: string | null; }; dsseEnvelope?: { @@ -34834,16 +36279,20 @@ export interface components { * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." */ "enterprise-webhooks": { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -34864,16 +36313,18 @@ export interface components { */ slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** @@ -34907,18 +36358,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -34931,7 +36382,10 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; }; /** @@ -34941,9 +36395,9 @@ export interface components { */ "repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -34972,16 +36426,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -35003,28 +36460,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -35046,13 +36503,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -35066,30 +36523,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -35097,25 +36554,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -35190,18 +36650,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -35210,6 +36673,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id?: number; node_id?: string; @@ -35456,7 +36920,7 @@ export interface components { authorized_actors_only: boolean; authorized_dismissal_actors_only: boolean; create_protected?: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; dismiss_stale_reviews_on_push: boolean; id: number; @@ -35490,24 +36954,34 @@ export interface components { /** @enum {string} */ signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; strict_required_status_checks_policy: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { - /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ + /** + * @nullable + * @example d6fde92930d4715a2b49857d24b940956b26d2d3 + */ after?: string | null; app?: components["schemas"]["integration"]; - /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ + /** + * @nullable + * @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 + */ before?: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at?: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch?: string | null; /** * @description The SHA of the head commit that is being checked. @@ -35525,7 +36999,7 @@ export interface components { * @enum {string} */ status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; - /** Format: date-time */ + /** @format date-time */ updated_at?: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ url?: string; @@ -35538,11 +37012,13 @@ export interface components { app: components["schemas"]["nullable-integration"]; check_suite: components["schemas"]["simple-check-suite"]; /** - * Format: date-time + * @nullable * @example 2018-05-04T01:14:52Z + * @format date-time */ completed_at: string | null; /** + * @nullable * @example neutral * @enum {string|null} */ @@ -35573,16 +37049,19 @@ export interface components { node_id: string; output: { annotations_count: number; - /** Format: uri */ + /** @format uri */ annotations_url: string; + /** @nullable */ summary: string | null; + /** @nullable */ text: string | null; + /** @nullable */ title: string | null; }; pull_requests: components["schemas"]["pull-request-minimal"][]; /** - * Format: date-time * @example 2018-05-04T01:14:52Z + * @format date-time */ started_at: string; /** @@ -35604,34 +37083,39 @@ export interface components { webhooks_ref_0: string; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ webhooks_deploy_key: { + /** @nullable */ added_by?: string | null; created_at: string; id: number; key: string; + /** @nullable */ last_used?: string | null; read_only: boolean; title: string; - /** Format: uri */ + /** @format uri */ url: string; verified: boolean; enabled?: boolean; }; - /** Workflow */ + /** + * Workflow + * @nullable + */ webhooks_workflow: { - /** Format: uri */ + /** @format uri */ badge_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; node_id: string; path: string; state: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; webhooks_approver: { @@ -35656,92 +37140,102 @@ export interface components { user_view_type?: string; }; webhooks_reviewers: { - /** User */ + /** + * User + * @nullable + */ reviewer?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @enum {string} */ type?: "User"; }[]; webhooks_workflow_job_run: { + /** @nullable */ conclusion: unknown; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: unknown; status: string; updated_at: string; }; - /** User */ + /** + * User + * @nullable + */ webhooks_user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35754,12 +37248,13 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; child_comment_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; discussion_id: number; html_url: string; id: number; node_id: string; + /** @nullable */ parent_id: unknown; /** Reactions */ reactions?: { @@ -35772,48 +37267,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35823,46 +37322,53 @@ export interface components { * @description A Discussion in a repository. */ discussion: { + /** @nullable */ active_lock_reason: string | null; + /** @nullable */ answer_chosen_at: string | null; - /** User */ + /** + * User + * @nullable + */ answer_chosen_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ answer_html_url: string | null; /** * AuthorAssociation @@ -35872,7 +37378,7 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; category: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -35885,7 +37391,7 @@ export interface components { updated_at: string; }; comments: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; html_url: string; id: number; @@ -35903,7 +37409,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; @@ -35915,6 +37421,7 @@ export interface components { */ state: "open" | "closed" | "locked" | "converting" | "transferring"; /** + * @nullable * @description The reason for the current state * @example resolved * @enum {string|null} @@ -35922,44 +37429,48 @@ export interface components { state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; timeline_url?: string; title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -35979,6 +37490,7 @@ export interface components { html_url: string; id: number; node_id: string; + /** @nullable */ parent_id: number | null; /** Reactions */ reactions: { @@ -35991,47 +37503,51 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; repository_url: string; updated_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36041,14 +37557,15 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }; @@ -36092,16 +37609,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: components["schemas"]["integration"]; @@ -36116,52 +37633,56 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36178,80 +37699,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ webhooks_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -36261,95 +37790,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36362,67 +37910,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36501,19 +38064,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -36527,10 +38096,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -36543,54 +38112,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36600,56 +38174,67 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36662,9 +38247,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -36672,80 +38257,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ webhooks_issue_2: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -36755,95 +38348,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -36856,67 +38468,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -36995,19 +38622,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -37021,10 +38654,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -37037,93 +38670,102 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** User */ + /** + * User + * @nullable + */ webhooks_user_mannequin: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -37133,11 +38775,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date: string | null; on_free_trial: boolean; plan: { @@ -37149,6 +38794,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -37160,11 +38806,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: unknown; + /** @nullable */ next_billing_date?: string | null; on_free_trial: boolean; plan: { @@ -37176,6 +38825,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -37187,25 +38837,32 @@ export interface components { */ webhooks_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -37219,12 +38876,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -37234,12 +38891,12 @@ export interface components { privacy?: "open" | "closed" | "secret"; /** @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -37260,14 +38917,15 @@ export interface components { }; /** * Repository + * @nullable * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** - * Format: int64 * @description Unique identifier of the repository * @example 42 + * @format int64 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ @@ -37296,16 +38954,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -37327,28 +38988,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -37370,13 +39031,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -37390,30 +39051,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -37421,25 +39082,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -37514,18 +39178,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -37534,6 +39201,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id?: number; node_id?: string; @@ -37771,56 +39439,67 @@ export interface components { * @description A collection of related issues and pull requests. */ webhooks_milestone_3: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -37833,9 +39512,9 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -37843,48 +39522,52 @@ export interface components { * @description The membership between the user and the organization. Not present when the action is `member_invited`. */ webhooks_membership: { - /** Format: uri */ + /** @format uri */ organization_url: string; role: string; state: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -37938,9 +39621,15 @@ export interface components { * @enum {string} */ repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + /** + * @nullable + * @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. + */ repositories: { full_name: string; /** @description Unique identifier of the repository */ @@ -37959,154 +39648,174 @@ export interface components { token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token expires. + */ token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + /** + * @nullable + * @description Date and time when the associated fine-grained personal access token was last used for authentication. + */ token_last_used_at: string | null; }; /** Project Card */ webhooks_project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project */ webhooks_project: { - /** @description Body of the project */ + /** + * @nullable + * @description Body of the project + */ body: string | null; - /** Format: uri */ + /** @format uri */ columns_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Name of the project */ name: string; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ owner_url: string; /** * @description State of the project; either 'open' or 'closed' * @enum {string} */ state: "open" | "closed"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** Project Column */ webhooks_project_column: { + /** @nullable */ after_id?: number | null; - /** Format: uri */ + /** @format uri */ cards_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The unique identifier of the project column */ id: number; /** @description Name of the project column */ name: string; node_id: string; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -38119,37 +39828,47 @@ export interface components { owner: components["schemas"]["simple-user"]; creator: components["schemas"]["simple-user"]; title: string; + /** @nullable */ description: string | null; public: boolean; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ closed_at: string | null; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; number: number; + /** @nullable */ short_description: string | null; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ deleted_at: string | null; deleted_by: components["schemas"]["nullable-simple-user"]; }; webhooks_project_changes: { archived_at?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ from?: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ to?: string | null; }; }; @@ -38171,18 +39890,19 @@ export interface components { content_type: components["schemas"]["projects-v2-item-content-type"]; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; /** - * Format: date-time + * @nullable * @example 2022-04-28T12:00:00Z + * @format date-time */ archived_at: string | null; }; @@ -38193,7 +39913,9 @@ export interface components { "projects-v2-single-select-option": { id: string; name: string; + /** @nullable */ color?: string | null; + /** @nullable */ description?: string | null; }; /** @@ -38203,7 +39925,9 @@ export interface components { "projects-v2-iteration-setting": { id: string; title: string; + /** @nullable */ duration?: number | null; + /** @nullable */ start_date?: string | null; }; /** @@ -38216,28 +39940,32 @@ export interface components { project_node_id?: string; creator?: components["schemas"]["simple-user"]; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2022-04-28T12:00:00Z + * @format date-time */ updated_at: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** - * Format: date * @example 2022-04-28 + * @format date */ start_date?: string; /** - * Format: date * @example 2022-04-28 + * @format date */ target_date?: string; /** + * @nullable * @description Body of the status update * @example The project is off to a great start! */ @@ -38299,120 +40027,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -38423,48 +40159,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -38505,32 +40252,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -38540,28 +40287,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -38589,37 +40337,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -38640,55 +40396,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -38702,11 +40465,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -38729,26 +40494,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -38763,60 +40528,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -38851,32 +40624,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -38886,28 +40659,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -38935,37 +40709,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -38986,55 +40768,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39048,11 +40837,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -39075,26 +40866,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. @@ -39109,168 +40900,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -39283,73 +41101,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -39358,12 +41185,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -39371,36 +41198,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -39409,12 +41243,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -39422,69 +41256,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39497,17 +41335,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -39521,20 +41359,23 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; @@ -39544,17 +41385,26 @@ export interface components { original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -39568,7 +41418,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -39576,9 +41426,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -39589,49 +41443,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -39641,12 +41499,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -39656,60 +41514,71 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; state: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ submitted_at: string | null; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ webhooks_nullable_string: string | null; /** * Release @@ -39717,13 +41586,14 @@ export interface components { */ webhooks_release: { assets: { - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -39734,103 +41604,119 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; }[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -39843,20 +41729,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; /** @@ -39865,13 +41757,14 @@ export interface components { */ webhooks_release_1: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -39882,103 +41775,119 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ prerelease: boolean; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -39991,20 +41900,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; /** @@ -40017,48 +41932,55 @@ export interface components { created_at: string; dismiss_reason?: string; dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -40070,6 +41992,7 @@ export interface components { state: "open"; }; /** + * @nullable * @description The reason for resolving the alert. * @enum {string|null} */ @@ -40081,18 +42004,22 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ + /** + * @nullable + * @description An optional comment to resolve an alert. + */ resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; @@ -40106,33 +42033,51 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ + /** + * @nullable + * @description An optional comment when reviewing a push protection bypass. + */ push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ + /** + * @nullable + * @description An optional comment when requesting a push protection bypass. + */ push_protection_bypass_request_comment?: string | null; /** - * Format: uri + * @nullable * @description The URL to a push protection bypass request. + * @format uri */ push_protection_bypass_request_html_url?: string | null; - /** @description Whether the detected secret was publicly leaked. */ + /** + * @nullable + * @description Whether the detected secret was publicly leaked. + */ publicly_leaked?: boolean | null; - /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + /** + * @nullable + * @description Whether the detected secret was found in multiple repositories in the same organization or business. + */ multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { cvss: { score: number; + /** @nullable */ vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -40148,13 +42093,14 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; summary: string; updated_at: string; vulnerabilities: { + /** @nullable */ first_patched_version: { identifier: string; } | null; @@ -40165,6 +42111,7 @@ export interface components { severity: string; vulnerable_version_range: string; }[]; + /** @nullable */ withdrawn_at: string | null; }; webhooks_sponsorship: { @@ -40192,79 +42139,87 @@ export interface components { }; node_id: string; privacy_level: string; - /** User */ + /** + * User + * @nullable + */ sponsor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** User */ + /** + * User + * @nullable + */ sponsorable: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40311,25 +42266,32 @@ export interface components { */ webhooks_team_1: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -40343,12 +42305,12 @@ export interface components { * @enum {string} */ notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -40361,12 +42323,12 @@ export interface components { * @enum {string} */ notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -40419,15 +42381,18 @@ export interface components { /** @description If the action was `edited`, the changes to the rule. */ changes?: { admin_enforced?: { + /** @nullable */ from: boolean | null; }; authorized_actor_names?: { from: string[]; }; authorized_actors_only?: { + /** @nullable */ from: boolean | null; }; authorized_dismissal_actors_only?: { + /** @nullable */ from: boolean | null; }; linear_history_requirement_enforcement_level?: { @@ -40439,6 +42404,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; lock_allows_fork_sync?: { + /** @nullable */ from: boolean | null; }; pull_request_reviews_enforcement_level?: { @@ -40446,6 +42412,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; require_last_push_approval?: { + /** @nullable */ from: boolean | null; }; required_status_checks?: { @@ -40546,63 +42513,81 @@ export interface components { action: "completed"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description The client ID of the GitHub app */ + /** + * @nullable + * @description The client ID of the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40681,20 +42666,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -40703,9 +42696,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40716,9 +42712,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40742,7 +42741,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -40753,28 +42752,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -40790,63 +42790,81 @@ export interface components { action: "requested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description Client ID of the GitHub app */ + /** + * @nullable + * @description Client ID of the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -40925,20 +42943,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -40947,9 +42973,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40960,9 +42989,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -40986,7 +43018,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -40997,28 +43029,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -41034,63 +43067,81 @@ export interface components { action: "rerequested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ check_suite: { + /** @nullable */ after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ app: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; - /** @description The Client ID for the GitHub app */ + /** + * @nullable + * @description The Client ID for the GitHub app + */ client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -41169,20 +43220,28 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; }; + /** @nullable */ before: string | null; - /** Format: uri */ + /** @format uri */ check_runs_url: string; /** + * @nullable * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** @description The head branch name the changes are on. */ + /** + * @nullable + * @description The head branch name the changes are on. + */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -41191,9 +43250,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -41204,9 +43266,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -41230,7 +43295,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -41241,28 +43306,29 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; rerequestable?: boolean; runs_rerequestable?: boolean; /** + * @nullable * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL that points to the check suite API resource. + * @format uri */ url: string; }; @@ -41279,67 +43345,79 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41375,12 +43453,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41388,10 +43468,13 @@ export interface components { tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41409,67 +43492,78 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41503,17 +43597,23 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** @@ -41522,13 +43622,17 @@ export interface components { */ state: "dismissed" | "fixed"; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41546,25 +43650,39 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time + * @nullable * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: unknown; + /** @nullable */ dismissed_by: unknown; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41598,33 +43716,46 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | null; + /** @nullable */ tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; } | null; + /** @nullable */ updated_at?: string | null; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41642,69 +43773,81 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; /** - * Format: date-time + * @nullable * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ dismissed_at: string | null; - /** User */ + /** + * User + * @nullable + */ dismissed_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** + * @nullable * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ instances_url?: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41738,32 +43881,43 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "fixed" | null; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41778,27 +43932,43 @@ export interface components { "webhook-code-scanning-alert-reopened": { /** @enum {string} */ action: "reopened"; - /** @description The code scanning alert involved in the event. */ + /** + * @nullable + * @description The code scanning alert involved in the event. + */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: string | null; + /** @nullable */ dismissed_by: Record | null; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: string | null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41832,40 +44002,57 @@ export interface components { /** @description A short description of the rule used to detect the alert. */ description: string; full_description?: string; + /** @nullable */ help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ + /** + * @nullable + * @description A link to the documentation for the rule used to detect the alert. + */ help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ id: string; name?: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; + /** @nullable */ tags?: string[] | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | "fixed" | null; tool: { + /** @nullable */ guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; } | null; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ commit_oid: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + /** + * @nullable + * @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. + */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -41877,24 +44064,37 @@ export interface components { /** @description The code scanning alert involved in the event. */ alert: { /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + * @format date-time */ created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ dismissed_at: unknown; + /** @nullable */ dismissed_by: unknown; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + /** + * @nullable + * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** + * @nullable + * @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ fixed_at?: unknown; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ html_url: string; - /** Alert Instance */ + /** + * Alert Instance + * @nullable + */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ analysis_key: string; @@ -41930,12 +44130,14 @@ export interface components { /** @description A unique identifier for the rule used to detect the alert. */ id: string; /** + * @nullable * @description The severity of the alert. * @enum {string|null} */ severity: "none" | "note" | "warning" | "error" | null; }; /** + * @nullable * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ @@ -41943,10 +44145,13 @@ export interface components { tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; - /** @description The version of the tool used to detect the alert. */ + /** + * @nullable + * @description The version of the tool used to detect the alert. + */ version: string | null; }; - /** Format: uri */ + /** @format uri */ url: string; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; @@ -41977,17 +44182,26 @@ export interface components { /** @description The SHA of the commit to which the comment applies. */ commit_id: string; created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The ID of the commit comment. */ id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the commit comment. */ node_id: string; - /** @description The relative path of the file to which the comment applies. */ + /** + * @nullable + * @description The relative path of the file to which the comment applies. + */ path: string | null; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; /** Reactions */ reactions?: { @@ -42000,48 +44214,52 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42054,7 +44272,10 @@ export interface components { }; /** create event */ "webhook-create": { - /** @description The repository's current description. */ + /** + * @nullable + * @description The repository's current description. + */ description: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; @@ -42242,44 +44463,49 @@ export interface components { */ deployment: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; environment: string; id: number; @@ -42288,58 +44514,73 @@ export interface components { payload: Record | string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42418,20 +44659,23 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -42440,43 +44684,50 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42485,13 +44736,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: unknown; head_repository?: { archive_url?: string; @@ -42505,6 +44760,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -42561,7 +44817,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -42569,6 +44825,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: unknown; pull_requests: { base: { @@ -42577,7 +44834,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -42588,16 +44845,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -42615,6 +44873,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -42673,51 +44932,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -42732,8 +44995,8 @@ export interface components { /** @description The event that triggered the deployment protection rule. */ event?: string; /** - * Format: uri * @description The URL to review the deployment protection rule. + * @format uri */ deployment_callback_url?: string; deployment?: components["schemas"]["deployment"]; @@ -42757,52 +45020,61 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { + /** @nullable */ conclusion?: unknown; created_at?: string; environment?: string; html_url?: string; id?: number; + /** @nullable */ name?: string | null; status?: string; updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -42811,13 +45083,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url?: string; @@ -42831,6 +45107,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -42888,7 +45165,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -42896,6 +45173,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -42904,7 +45182,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -42915,16 +45193,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -42942,6 +45221,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43001,51 +45281,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43065,52 +45349,61 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { + /** @nullable */ conclusion?: string | null; created_at?: string; environment?: string; html_url?: string; id?: number; + /** @nullable */ name?: string | null; status?: string; updated_at?: string; }[]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43119,12 +45412,16 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url?: string; @@ -43138,6 +45435,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43195,7 +45493,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -43203,6 +45501,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -43211,7 +45510,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -43222,16 +45521,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -43249,6 +45549,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43308,51 +45609,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43369,41 +45674,45 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; requestor: components["schemas"]["webhooks_user"]; reviewers: { - /** User */ + /** + * User + * @nullable + */ reviewer?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43413,52 +45722,61 @@ export interface components { sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { + /** @nullable */ conclusion: unknown; created_at: string; environment: string; html_url: string; id: number; + /** @nullable */ name: string | null; status: string; updated_at: string; }; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43467,12 +45785,16 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; head_branch: string; + /** @nullable */ head_commit?: Record | null; head_repository?: { archive_url?: string; @@ -43486,6 +45808,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43543,7 +45866,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -43551,6 +45874,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: string | null; pull_requests: { base: { @@ -43559,7 +45883,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -43570,16 +45894,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -43597,6 +45922,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: string | null; downloads_url?: string; events_url?: string; @@ -43656,51 +45982,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -43711,34 +46041,39 @@ export interface components { "webhook-deployment-status-created": { /** @enum {string} */ action: "created"; + /** @nullable */ check_run?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ completed_at: string | null; /** + * @nullable * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ + /** @format uri */ details_url: string; external_id: string; /** @description The SHA of the commit that is being checked. */ head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description The id of the check. */ id: number; /** @description The name of the check run. */ name: string; node_id: string; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ + /** @format uri */ url: string; } | null; /** @@ -43747,104 +46082,125 @@ export interface components { */ deployment: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; environment: string; id: number; node_id: string; original_environment: string; + /** @nullable */ payload: (string | Record) | null; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -43923,128 +46279,150 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; production_environment?: boolean; ref: string; - /** Format: uri */ + /** @format uri */ repository_url: string; sha: string; - /** Format: uri */ + /** @format uri */ statuses_url: string; task: string; transient_environment?: boolean; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ deployment_url: string; /** @description The optional human-readable description added to the status. */ description: string; environment: string; - /** Format: uri */ + /** @format uri */ environment_url?: string; id: number; - /** Format: uri */ + /** @format uri */ log_url?: string; node_id: string; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44123,17 +46501,20 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; - /** Format: uri */ + /** @format uri */ repository_url: string; /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ state: string; /** @description The optional link added to the status. */ target_url: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -44142,43 +46523,50 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; - /** Deployment Workflow Run */ + /** + * Deployment Workflow Run + * @nullable + */ workflow_run?: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44187,13 +46575,17 @@ export interface components { check_suite_id: number; check_suite_node_id: string; check_suite_url?: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; display_title: string; event: string; head_branch: string; + /** @nullable */ head_commit?: unknown; head_repository?: { archive_url?: string; @@ -44207,6 +46599,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -44263,7 +46656,7 @@ export interface components { url?: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; jobs_url?: string; @@ -44271,6 +46664,7 @@ export interface components { name: string; node_id: string; path: string; + /** @nullable */ previous_attempt_url?: unknown; pull_requests: { base: { @@ -44279,7 +46673,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -44290,16 +46684,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -44317,6 +46712,7 @@ export interface components { contents_url?: string; contributors_url?: string; deployments_url?: string; + /** @nullable */ description?: unknown; downloads_url?: string; events_url?: string; @@ -44375,51 +46771,55 @@ export interface components { rerun_url?: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; workflow_url?: string; @@ -44444,7 +46844,7 @@ export interface components { changes: { category: { from: { - /** Format: date-time */ + /** @format date-time */ created_at: string; description: string; emoji: string; @@ -44693,32 +47093,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -44728,28 +47128,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -44772,89 +47173,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -44868,36 +47284,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -44922,6 +47340,7 @@ export interface components { created_at?: string; default_branch?: string; deployments_url?: string; + /** @nullable */ description?: string | null; disabled?: boolean; downloads_url?: string; @@ -44941,6 +47360,7 @@ export interface components { has_pages?: boolean; has_projects?: boolean; has_wiki?: boolean; + /** @nullable */ homepage?: string | null; hooks_url?: string; html_url?: string; @@ -44951,11 +47371,14 @@ export interface components { issues_url?: string; keys_url?: string; labels_url?: string; + /** @nullable */ language?: unknown; languages_url?: string; + /** @nullable */ license?: Record | null; merges_url?: string; milestones_url?: string; + /** @nullable */ mirror_url?: unknown; name?: string; node_id?: string; @@ -45029,14 +47452,15 @@ export interface components { */ action: "created" | "edited"; /** - * Format: uri * @description Points to the HTML wiki page. + * @format uri */ html_url: string; /** @description The name of the page. */ page_name: string; /** @description The latest commit SHA of the page. */ sha: string; + /** @nullable */ summary: string | null; /** @description The current page title. */ title: string; @@ -45065,6 +47489,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45077,6 +47502,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45137,14 +47563,17 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { + /** @nullable */ archived_at?: string | null; avatar_url: string; created_at?: string; + /** @nullable */ description?: unknown; events_url?: string; followers?: number; @@ -45177,6 +47606,7 @@ export interface components { type?: string; updated_at?: string; url?: string; + /** @nullable */ website_url?: unknown; user_view_type?: string; }; @@ -45206,6 +47636,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; + /** @nullable */ requester?: unknown; sender: components["schemas"]["simple-user"]; }; @@ -45226,16 +47657,16 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ body: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the issue comment + * @format int64 */ id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; node_id: string; performed_via_github_app: components["schemas"]["nullable-integration"]; @@ -45250,52 +47681,56 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45304,80 +47739,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -45387,95 +47830,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -45488,67 +47950,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -45627,19 +48104,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -45653,10 +48136,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -45669,100 +48152,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -45774,22 +48269,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -45821,7 +48319,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -45848,80 +48346,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -45931,95 +48437,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -46032,67 +48557,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46171,19 +48711,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -46197,10 +48743,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -46213,100 +48759,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -46318,22 +48876,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -46365,7 +48926,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -46394,80 +48955,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -46477,95 +49046,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -46578,67 +49166,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -46717,19 +49320,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -46743,10 +49352,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -46759,100 +49368,112 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at?: string | null; comments?: number; comments_url?: string; @@ -46864,22 +49485,25 @@ export interface components { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; labels_url?: string; locked: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -46911,7 +49535,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -46955,80 +49579,88 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -47038,95 +49670,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -47139,67 +49790,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47278,19 +49944,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -47304,10 +49976,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -47320,63 +49992,72 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; } & { + /** @nullable */ active_lock_reason?: string | null; + /** @nullable */ assignee?: Record | null; assignees?: (Record | null)[]; author_association?: string; + /** @nullable */ body?: string | null; + /** @nullable */ closed_at: string | null; comments?: number; comments_url?: string; @@ -47387,9 +50068,11 @@ export interface components { labels?: (Record | null)[]; labels_url?: string; locked?: boolean; + /** @nullable */ milestone?: Record | null; node_id?: string; number?: number; + /** @nullable */ performed_via_github_app?: Record | null; reactions?: { "+1"?: number; @@ -47418,7 +50101,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; - /** Format: int64 */ + /** @format int64 */ id?: number; login?: string; node_id?: string; @@ -47448,80 +50131,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -47530,95 +50221,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -47631,67 +50341,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47770,19 +50495,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -47796,10 +50527,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -47812,54 +50543,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -47879,79 +50615,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -47960,95 +50704,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48061,67 +50824,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48200,19 +50978,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -48226,10 +51010,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -48242,54 +51026,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48321,80 +51110,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -48403,95 +51200,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48504,67 +51320,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48643,19 +51474,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -48669,10 +51506,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -48685,54 +51522,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -48753,80 +51595,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -48835,95 +51685,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -48936,67 +51805,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49075,19 +51959,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49101,10 +51991,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49117,54 +52007,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49185,80 +52080,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -49268,96 +52171,115 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: true; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -49370,67 +52292,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49509,19 +52446,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49535,10 +52478,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49551,54 +52494,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49618,79 +52566,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -49699,95 +52655,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -49800,67 +52775,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -49939,19 +52929,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -49965,10 +52961,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -49981,54 +52977,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50045,83 +53046,92 @@ export interface components { changes?: { /** * Issue + * @nullable * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ old_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50131,95 +53141,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50232,67 +53261,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50371,19 +53415,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -50397,10 +53447,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -50413,54 +53463,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50493,32 +53548,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -50532,28 +53587,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** @description Whether the repository has discussions enabled. */ has_discussions?: boolean; @@ -50578,89 +53634,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -50674,36 +53745,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -50720,80 +53793,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -50803,95 +53884,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -50904,67 +54004,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51043,19 +54158,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51069,10 +54190,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51085,54 +54206,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51163,79 +54289,87 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -51244,95 +54378,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51345,67 +54498,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51484,19 +54652,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51510,10 +54684,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51526,54 +54700,59 @@ export interface components { * @enum {string} */ state: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51592,80 +54771,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ new_issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -51675,95 +54862,114 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; locked?: boolean; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -51776,67 +54982,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -51915,19 +55136,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -51941,10 +55168,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -51957,54 +55184,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52037,32 +55269,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -52076,28 +55308,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -52125,89 +55358,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52221,36 +55469,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -52305,80 +55555,88 @@ export interface components { * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -52388,96 +55646,115 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ + /** + * @nullable + * @description Contents of the issue + */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments: number; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; draft?: boolean; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: int64 */ + /** @format int64 */ id: number; labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; } | null)[]; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; /** @enum {boolean} */ locked: false; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -52490,67 +55767,82 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; /** * App + * @nullable * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ performed_via_github_app?: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; + /** @nullable */ description: string | null; /** @description The list of events for the GitHub app */ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_url: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ + /** + * @nullable + * @description Unique identifier of the GitHub app + */ id: number | null; /** @description The name of the GitHub app */ name: string; node_id: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52629,19 +55921,25 @@ export interface components { }; /** @description The slug name of the GitHub app */ slug?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ updated_at: string | null; } | null; pull_request?: { - /** Format: uri */ + /** @format uri */ diff_url?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at?: string | null; - /** Format: uri */ + /** @format uri */ patch_url?: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** Reactions */ @@ -52655,10 +55953,10 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ repository_url: string; /** Sub-issues Summary */ sub_issues_summary?: { @@ -52671,54 +55969,59 @@ export interface components { * @enum {string} */ state?: "open" | "closed"; + /** @nullable */ state_reason?: string | null; - /** Format: uri */ + /** @format uri */ timeline_url?: string; /** @description Title of the issue */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the issue + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -52814,12 +56117,16 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date?: string | null; + /** @nullable */ on_free_trial: boolean | null; plan: { bullets: string[]; @@ -52830,6 +56137,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52853,11 +56161,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: string | null; + /** @nullable */ next_billing_date?: string | null; on_free_trial: boolean; plan: { @@ -52869,6 +56180,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52890,11 +56202,14 @@ export interface components { id: number; login: string; node_id: string; + /** @nullable */ organization_billing_email: string | null; type: string; }; billing_cycle: string; + /** @nullable */ free_trial_ends_on: unknown; + /** @nullable */ next_billing_date: string | null; on_free_trial: boolean; plan: { @@ -52906,6 +56221,7 @@ export interface components { name: string; /** @enum {string} */ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + /** @nullable */ unit_name: string | null; yearly_price_in_cents: number; }; @@ -52967,7 +56283,9 @@ export interface components { from: string; }; permission?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; }; @@ -53003,41 +56321,45 @@ export interface components { * @enum {string} */ scope: "team"; - /** User */ + /** + * User + * @nullable + */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53057,41 +56379,45 @@ export interface components { * @enum {string} */ scope: "team" | "organization"; - /** User */ + /** + * User + * @nullable + */ sender: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53133,7 +56459,7 @@ export interface components { content_type: "json" | "form"; insecure_ssl: string; secret?: string; - /** Format: uri */ + /** @format uri */ url: string; }; created_at: string; @@ -53272,53 +56598,63 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ invitation: { - /** Format: date-time */ + /** @format date-time */ created_at: string; + /** @nullable */ email: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ failed_at: string | null; + /** @nullable */ failed_reason: string | null; id: number; - /** Format: uri */ + /** @format uri */ invitation_teams_url: string; - /** User */ + /** + * User + * @nullable + */ inviter: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ login: string | null; node_id: string; role: string; @@ -53385,96 +56721,110 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ package: { + /** @nullable */ created_at: string | null; + /** @nullable */ description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; package_type: string; + /** @nullable */ package_version: { - /** User */ + /** + * User + * @nullable + */ author?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; body?: string | Record; body_html?: string; + /** @nullable */ container_metadata?: { + /** @nullable */ labels?: Record | null; + /** @nullable */ manifest?: Record | null; tag?: { digest?: string; @@ -53487,7 +56837,7 @@ export interface components { tags?: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -53496,22 +56846,27 @@ export interface components { [key: string]: unknown; }[]; name: string; + /** @nullable */ npm_metadata?: { name?: string; version?: string; npm_user?: string; + /** @nullable */ author?: Record | null; + /** @nullable */ bugs?: Record | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; + /** @nullable */ dist?: Record | null; git_head?: string; homepage?: string; license?: string; main?: string; + /** @nullable */ repository?: Record | null; scripts?: Record; id?: string; @@ -53525,6 +56880,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; + /** @nullable */ directories?: Record | null; os?: string[]; cpu?: string[]; @@ -53535,6 +56891,7 @@ export interface components { published_via_actions?: boolean; deleted_by_id?: number; } | null; + /** @nullable */ nuget_metadata?: { id?: number | string; name?: string; @@ -53548,69 +56905,78 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; + /** @nullable */ sha256: string | null; size: number; + /** @nullable */ state: string | null; updated_at: string; }[]; package_url?: string; prerelease?: boolean; release?: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; prerelease: boolean; published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; @@ -53622,15 +56988,17 @@ export interface components { updated_at?: string; version: string; } | null; + /** @nullable */ registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; + /** @nullable */ updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; @@ -53646,88 +57014,97 @@ export interface components { /** @description Information about the package. */ package: { created_at: string; + /** @nullable */ description: string | null; ecosystem: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; namespace: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; package_type: string; package_version: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -53739,7 +57116,7 @@ export interface components { tags?: string[]; }[]; draft?: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; installation_command: string; @@ -53751,11 +57128,13 @@ export interface components { package_files: { content_type: string; created_at: string; - /** Format: uri */ + /** @format uri */ download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; sha256: string; size: number; @@ -53765,47 +57144,51 @@ export interface components { package_url?: string; prerelease?: boolean; release?: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; created_at: string; draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; name: string; @@ -53813,11 +57196,11 @@ export interface components { published_at: string; tag_name: string; target_commitish: string; - /** Format: uri */ + /** @format uri */ url: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - /** Format: uri */ + /** @format uri */ source_url?: string; summary: string; tag_name?: string; @@ -53826,12 +57209,13 @@ export interface components { updated_at: string; version: string; }; + /** @nullable */ registry: { - /** Format: uri */ + /** @format uri */ about_url: string; name: string; type: string; - /** Format: uri */ + /** @format uri */ url: string; vendor: string; } | null; @@ -53844,53 +57228,59 @@ export interface components { "webhook-page-build": { /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ build: { + /** @nullable */ commit: string | null; created_at: string; duration: number; error: { + /** @nullable */ message: string | null; }; - /** User */ + /** + * User + * @nullable + */ pusher: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; status: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -53956,9 +57346,9 @@ export interface components { secret?: components["schemas"]["webhook-config-secret"]; url?: components["schemas"]["webhook-config-url"]; }; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: uri */ + /** @format uri */ deliveries_url?: string; /** @description Determines what events the hook is triggered for. Default: ['push']. */ events: string[]; @@ -53970,14 +57360,14 @@ export interface components { * @enum {string} */ name: "web"; - /** Format: uri */ + /** @format uri */ ping_url?: string; - /** Format: uri */ + /** @format uri */ test_url?: string; type: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url?: string; }; /** @description The ID of the webhook that triggered the ping. */ @@ -54029,63 +57419,70 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; + /** @nullable */ column_id: number | null; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; @@ -54097,6 +57494,7 @@ export interface components { action: "edited"; changes: { note: { + /** @nullable */ from: string | null; }; }; @@ -54120,70 +57518,78 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; project_card: { + /** @nullable */ after_id?: number | null; /** @description Whether or not the card is archived */ archived: boolean; column_id: number; - /** Format: uri */ + /** @format uri */ column_url: string; - /** Format: uri */ + /** @format uri */ content_url?: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description The project card's ID */ id: number; node_id: string; + /** @nullable */ note: string | null; - /** Format: uri */ + /** @format uri */ project_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } & { + /** @nullable */ after_id: number | null; archived?: boolean; column_id?: number; column_url?: string; created_at?: string; + /** @nullable */ creator?: { avatar_url?: string; events_url?: string; @@ -54206,6 +57612,7 @@ export interface components { } | null; id?: number; node_id?: string; + /** @nullable */ note?: string | null; project_url?: string; updated_at?: string; @@ -54362,7 +57769,9 @@ export interface components { action: "edited"; changes: { description?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; public?: { @@ -54370,7 +57779,9 @@ export interface components { to?: boolean; }; short_description?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; title?: { @@ -54399,6 +57810,7 @@ export interface components { action: "converted"; changes: { content_type?: { + /** @nullable */ from?: string | null; to?: string; }; @@ -54440,12 +57852,16 @@ export interface components { field_type?: string; field_name?: string; project_number?: number; + /** @nullable */ from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + /** @nullable */ to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; }; } | { body: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; }; @@ -54460,7 +57876,9 @@ export interface components { action: "reordered"; changes: { previous_projects_v2_item_node_id?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; }; @@ -54512,25 +57930,45 @@ export interface components { action: "edited"; changes?: { body?: { + /** @nullable */ from?: string | null; + /** @nullable */ to?: string | null; }; status?: { - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; start_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ to?: string | null; }; target_date?: { - /** Format: date */ + /** + * @nullable + * @format date + */ from?: string | null; - /** Format: date */ + /** + * @nullable + * @format date + */ to?: string | null; }; }; @@ -54561,120 +57999,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -54686,48 +58132,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54768,32 +58225,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -54803,28 +58260,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -54852,37 +58310,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -54903,55 +58369,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -54965,11 +58438,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -54992,26 +58467,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55026,68 +58501,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -55114,32 +58599,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -55149,28 +58634,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -55198,37 +58684,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -55249,55 +58743,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55311,11 +58812,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -55338,26 +58841,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -55372,168 +58875,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -55546,74 +59076,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -55622,12 +59161,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -55635,36 +59174,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -55673,12 +59219,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -55686,69 +59232,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55769,120 +59319,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -55893,48 +59451,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -55975,32 +59544,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -56010,28 +59579,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -56059,37 +59629,45 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -56110,55 +59688,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56172,11 +59757,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -56199,26 +59786,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56233,60 +59820,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -56321,32 +59916,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -56356,28 +59951,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -56405,37 +60001,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -56456,55 +60060,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56518,11 +60129,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -56545,26 +60158,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -56579,168 +60192,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -56753,74 +60393,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -56829,12 +60478,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -56842,36 +60491,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -56880,12 +60536,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -56893,69 +60549,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -56977,120 +60637,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -57101,48 +60769,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57183,32 +60862,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -57218,28 +60897,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -57267,37 +60947,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -57318,55 +61006,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57380,11 +61075,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -57407,26 +61104,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57441,60 +61138,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -57529,32 +61234,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -57564,28 +61269,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -57613,34 +61319,42 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -57661,55 +61375,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -57723,11 +61444,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -57750,26 +61473,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -57784,168 +61507,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -57958,74 +61708,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -58034,12 +61793,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -58047,36 +61806,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -58085,12 +61851,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -58098,69 +61864,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58218,120 +61988,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -58342,48 +62120,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58424,32 +62213,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -58459,28 +62248,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -58508,37 +62298,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -58559,55 +62357,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58621,11 +62426,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -58648,26 +62455,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -58682,60 +62489,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -58770,32 +62585,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -58805,28 +62620,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -58854,37 +62670,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -58905,55 +62729,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -58967,11 +62798,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -58994,26 +62827,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59028,168 +62861,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -59202,74 +63062,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59278,12 +63147,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59291,36 +63160,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -59329,12 +63205,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -59342,69 +63218,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59458,120 +63338,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -59582,48 +63470,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59664,32 +63563,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -59699,28 +63598,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -59748,37 +63648,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -59799,55 +63707,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -59861,11 +63776,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -59888,26 +63805,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -59922,60 +63839,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -60010,32 +63935,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60045,28 +63970,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60094,37 +64020,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -60145,55 +64079,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60207,11 +64148,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -60234,26 +64177,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -60268,168 +64211,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -60442,74 +64412,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -60518,12 +64497,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -60531,36 +64510,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -60569,12 +64555,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -60582,69 +64568,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60666,120 +64656,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -60790,48 +64788,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -60872,32 +64881,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -60907,28 +64916,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -60956,37 +64966,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -61007,55 +65025,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61069,11 +65094,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -61096,26 +65123,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61130,68 +65157,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -61218,32 +65255,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -61253,28 +65290,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -61302,37 +65340,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -61353,55 +65399,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61415,11 +65468,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -61442,26 +65497,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -61476,168 +65531,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -61650,74 +65732,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61726,12 +65817,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61739,36 +65830,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -61777,12 +65875,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -61790,69 +65888,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -61873,120 +65975,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -61997,48 +66107,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62079,32 +66200,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -62114,28 +66235,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -62163,37 +66285,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -62214,55 +66344,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62276,11 +66413,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -62303,26 +66442,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62337,68 +66476,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -62425,32 +66574,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -62460,28 +66609,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -62509,37 +66659,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -62560,55 +66718,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -62622,11 +66787,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -62649,26 +66816,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -62683,168 +66850,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -62857,74 +67051,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62933,12 +67136,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62946,36 +67149,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -62984,12 +67194,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -62997,69 +67207,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63127,17 +67341,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -63151,40 +67365,55 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -63198,7 +67427,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -63206,9 +67435,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -63219,49 +67452,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63273,119 +67510,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -63396,48 +67641,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63478,32 +67734,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63513,28 +67769,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63562,37 +67819,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -63613,55 +67878,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -63675,11 +67947,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -63702,26 +67976,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -63736,54 +68010,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -63791,6 +68071,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -63817,32 +68098,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -63852,28 +68133,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -63901,37 +68183,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -63952,55 +68242,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64014,11 +68311,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -64041,26 +68340,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64075,124 +68374,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -64205,72 +68523,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64279,12 +68605,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64292,36 +68618,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -64330,12 +68663,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -64343,63 +68676,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64419,119 +68756,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -64542,48 +68887,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64624,32 +68980,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -64659,28 +69015,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -64708,37 +69065,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -64759,55 +69124,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -64821,11 +69193,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -64848,26 +69222,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -64882,54 +69256,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -64937,6 +69317,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -64963,32 +69344,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -64998,28 +69379,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65047,37 +69429,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -65098,55 +69488,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65160,11 +69557,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -65187,26 +69586,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -65221,124 +69620,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -65351,72 +69769,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65425,12 +69851,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -65438,36 +69864,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -65476,12 +69909,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -65489,63 +69922,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65566,119 +70003,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -65690,48 +70135,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge?: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65772,32 +70228,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -65807,28 +70263,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -65856,37 +70313,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -65907,55 +70372,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -65969,11 +70441,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -65996,26 +70470,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66030,54 +70504,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft?: boolean; head: { @@ -66085,6 +70565,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -66111,32 +70592,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66146,28 +70627,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -66195,37 +70677,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -66246,55 +70736,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66308,11 +70805,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -66335,26 +70834,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -66369,124 +70868,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -66499,72 +71017,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -66573,12 +71099,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -66586,36 +71112,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -66624,12 +71157,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -66637,64 +71170,68 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; user_view_type?: string; - /** Format: uri */ + /** @format uri */ url?: string; } | null; }; @@ -66713,119 +71250,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -66836,48 +71381,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -66918,32 +71474,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -66953,28 +71509,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -67002,37 +71559,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -67053,55 +71618,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67115,11 +71687,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -67142,26 +71716,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67176,54 +71750,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -67231,6 +71811,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -67257,32 +71838,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -67292,28 +71873,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -67341,37 +71923,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -67392,55 +71982,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67454,11 +72051,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -67481,26 +72080,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -67515,124 +72114,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -67645,72 +72263,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67719,12 +72345,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67732,36 +72358,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -67770,12 +72403,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -67783,63 +72416,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67850,12 +72487,12 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -67865,57 +72502,64 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description The text of the review. */ + /** + * @nullable + * @description The text of the review. + */ body: string | null; /** @description A commit SHA for the review. */ commit_id: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the review */ id: number; node_id: string; - /** Format: uri */ + /** @format uri */ pull_request_url: string; /** @enum {string} */ state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ + /** @format date-time */ submitted_at: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -67940,119 +72584,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -68063,48 +72715,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68145,32 +72808,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68180,28 +72843,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68224,89 +72888,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68320,36 +72999,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -68357,54 +73038,60 @@ export interface components { watchers_count: number; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -68412,6 +73099,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -68438,32 +73126,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -68473,28 +73161,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -68517,89 +73206,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68613,36 +73317,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -68650,124 +73356,143 @@ export interface components { watchers_count: number; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -68780,72 +73505,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68854,12 +73587,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68867,36 +73600,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -68905,12 +73645,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -68918,63 +73658,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -68997,120 +73741,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -69122,48 +73874,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69204,32 +73967,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -69239,28 +74002,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -69288,37 +74052,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -69339,55 +74111,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69401,11 +74180,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -69421,26 +74202,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69455,60 +74236,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -69543,32 +74332,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -69578,28 +74367,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -69627,37 +74417,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -69678,55 +74476,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -69740,11 +74545,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -69767,26 +74574,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -69801,168 +74608,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -69975,74 +74809,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70051,12 +74894,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70064,36 +74907,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -70102,12 +74952,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -70115,109 +74965,117 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70235,120 +75093,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -70360,48 +75226,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70442,32 +75319,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70477,28 +75354,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70526,37 +75404,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -70577,55 +75463,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70639,11 +75532,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -70666,26 +75561,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -70700,60 +75595,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -70788,32 +75691,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -70823,28 +75726,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -70872,37 +75776,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -70923,55 +75835,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -70985,11 +75904,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -71012,26 +75933,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71046,168 +75967,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -71220,74 +76168,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71296,12 +76253,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71309,36 +76266,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71347,12 +76311,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71360,69 +76324,73 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71434,25 +76402,32 @@ export interface components { */ requested_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -71461,12 +76436,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -71474,12 +76449,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; }; @@ -71499,120 +76474,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -71624,48 +76607,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71706,32 +76700,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -71741,28 +76735,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -71790,37 +76785,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -71841,55 +76844,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -71903,11 +76913,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -71930,26 +76942,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -71964,60 +76976,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -72052,32 +77072,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72087,28 +77107,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -72136,37 +77157,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -72187,55 +77216,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72249,11 +77285,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -72276,26 +77314,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -72310,168 +77348,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -72484,74 +77549,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -72560,12 +77634,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -72573,36 +77647,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -72611,12 +77692,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -72624,109 +77705,117 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ + /** + * User + * @nullable + */ requested_reviewer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72744,120 +77833,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null)[]; @@ -72869,48 +77966,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -72951,32 +78059,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -72986,28 +78094,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73035,37 +78144,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -73086,55 +78203,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73148,11 +78272,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -73175,26 +78301,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73209,60 +78335,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -73297,32 +78431,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -73332,28 +78466,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -73381,37 +78516,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -73432,55 +78575,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73494,11 +78644,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -73521,26 +78673,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -73555,168 +78707,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -73729,74 +78908,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73805,12 +78993,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73818,36 +79006,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73856,12 +79051,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73869,69 +79064,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -73943,25 +79142,32 @@ export interface components { */ requested_team: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -73970,12 +79176,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -73983,12 +79189,12 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }; @@ -74006,119 +79212,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -74129,48 +79343,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74211,32 +79436,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -74246,28 +79471,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -74295,37 +79521,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -74346,55 +79580,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74408,11 +79649,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -74435,26 +79678,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74469,61 +79712,69 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -74550,32 +79801,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -74585,28 +79836,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -74634,37 +79886,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -74685,55 +79945,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -74747,11 +80014,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -74774,26 +80043,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -74808,124 +80077,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -74938,72 +80226,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75012,12 +80308,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75025,36 +80321,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -75063,12 +80366,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -75076,63 +80379,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75153,119 +80460,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -75276,48 +80591,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75358,32 +80684,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75393,28 +80719,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -75442,89 +80769,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75538,36 +80880,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -75577,61 +80921,69 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -75658,32 +81010,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -75693,28 +81045,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -75742,89 +81095,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -75838,36 +81206,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -75877,124 +81247,143 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -76007,72 +81396,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76081,12 +81478,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76094,36 +81491,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -76132,12 +81536,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -76145,63 +81549,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76213,17 +81621,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -76237,40 +81645,55 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -76284,7 +81707,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -76292,9 +81715,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -76305,49 +81732,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76367,119 +81798,127 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -76490,48 +81929,56 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; /** @description Title for the merge commit message. */ commit_title: string; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76572,32 +82019,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -76607,28 +82054,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76656,89 +82104,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -76752,36 +82215,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -76791,54 +82256,60 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; + /** @nullable */ closed_at: string | null; - /** Format: uri */ + /** @format uri */ comments_url: string; - /** Format: uri */ + /** @format uri */ commits_url: string; created_at: string; - /** Format: uri */ + /** @format uri */ diff_url: string; draft: boolean; head: { @@ -76872,32 +82343,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -76907,28 +82378,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -76956,89 +82428,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77052,36 +82539,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -77091,124 +82580,143 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ merged_at: string | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -77221,72 +82729,80 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -77295,12 +82811,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -77308,36 +82824,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -77346,12 +82869,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -77359,63 +82882,67 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; title: string; updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77427,17 +82954,17 @@ export interface components { _links: { /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ pull_request: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; @@ -77451,20 +82978,23 @@ export interface components { body: string; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; /** @description The diff of the line that the comment refers to. */ diff_hunk: string; /** - * Format: uri * @description HTML URL for the pull request review comment. + * @format uri */ html_url: string; /** @description The ID of the pull request review comment. */ id: number; /** @description The comment ID to reply to. */ in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + /** + * @nullable + * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ line: number | null; /** @description The node ID of the pull request review comment. */ node_id: string; @@ -77474,17 +83004,26 @@ export interface components { original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. */ + /** + * @nullable + * @description The line index in the diff to which the comment applies. + */ position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * @nullable + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; /** - * Format: uri * @description URL for the pull request that the review comment belongs to. + * @format uri */ pull_request_url: string; /** Reactions */ @@ -77498,7 +83037,7 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @@ -77506,9 +83045,13 @@ export interface components { * @enum {string} */ side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ + /** + * @nullable + * @description The first line of the range for a multi-line comment. + */ start_line: number | null; /** + * @nullable * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} @@ -77519,49 +83062,53 @@ export interface components { * @enum {string} */ subject_type?: "line" | "file"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; /** - * Format: uri * @description URL for the pull request review comment + * @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77584,120 +83131,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -77708,48 +83263,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77790,32 +83356,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -77825,28 +83391,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -77874,37 +83441,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -77925,55 +83500,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -77987,11 +83569,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -78014,26 +83598,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78048,60 +83632,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -78136,32 +83728,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -78171,28 +83763,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -78220,37 +83813,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -78264,55 +83865,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78326,11 +83934,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -78353,26 +83963,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -78387,168 +83997,195 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -78561,74 +84198,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78637,12 +84283,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78650,36 +84296,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -78688,12 +84341,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -78701,69 +84354,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78785,120 +84442,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -78909,48 +84574,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -78961,6 +84637,7 @@ export interface components { merge_method: "merge" | "squash" | "rebase"; } | null; base: { + /** @nullable */ label: string | null; ref: string; /** @@ -78991,32 +84668,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79026,28 +84703,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79075,37 +84753,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -79126,55 +84812,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79188,11 +84881,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -79215,26 +84910,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79249,68 +84944,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -79337,32 +85042,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -79372,28 +85077,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -79421,37 +85127,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -79472,55 +85186,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79534,11 +85255,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -79561,26 +85284,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -79595,168 +85318,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -79769,74 +85519,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79845,12 +85604,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79858,36 +85617,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -79896,12 +85662,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -79909,69 +85675,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -79993,120 +85763,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -80117,48 +85895,59 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; - /** @description Title for the merge commit message. */ + /** + * @nullable + * @description Title for the merge commit message. + */ commit_title: string | null; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80199,32 +85988,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -80234,28 +86023,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -80283,37 +86073,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -80334,55 +86132,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80396,11 +86201,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -80423,26 +86230,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80457,68 +86264,78 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { + /** @nullable */ label: string | null; ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -80545,32 +86362,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -80580,28 +86397,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -80629,37 +86447,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -80673,55 +86499,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -80735,11 +86568,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -80762,26 +86597,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -80796,168 +86631,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -80970,74 +86832,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; node_id: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81046,12 +86917,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81059,36 +86930,43 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -81097,12 +86975,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -81110,69 +86988,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81193,120 +87075,128 @@ export interface components { _links: { /** Link */ comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ commits: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ html: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ issue: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comment: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ review_comments: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ self: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; /** Link */ statuses: { - /** Format: uri-template */ + /** @format uri-template */ href: string; }; }; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; additions?: number; - /** User */ + /** + * User + * @nullable + */ assignee: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; assignees: ({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null)[]; /** @@ -81317,48 +87207,56 @@ export interface components { author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge + * @nullable * @description The status of auto merging a pull request. */ auto_merge: { - /** @description Commit message for the merge commit. */ + /** + * @nullable + * @description Commit message for the merge commit. + */ commit_message: string | null; /** @description Title for the merge commit message. */ commit_title: string; - /** User */ + /** + * User + * @nullable + */ enabled_by: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81399,32 +87297,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -81434,28 +87332,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -81483,37 +87382,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -81534,55 +87441,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81596,11 +87510,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -81623,26 +87539,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -81657,60 +87573,68 @@ export interface components { web_commit_signoff_required?: boolean; }; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; + /** @nullable */ body: string | null; changed_files?: number; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; comments?: number; - /** Format: uri */ + /** @format uri */ comments_url: string; commits?: number; - /** Format: uri */ + /** @format uri */ commits_url: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; deletions?: number; - /** Format: uri */ + /** @format uri */ diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; @@ -81719,6 +87643,7 @@ export interface components { ref: string; /** * Repository + * @nullable * @description A git repository */ repo: { @@ -81745,32 +87670,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; created_at: number | string; /** @description The default branch of the repository. */ @@ -81780,28 +87705,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -81829,37 +87755,45 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; @@ -81880,55 +87814,62 @@ export interface components { * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -81942,11 +87883,13 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; /** @@ -81969,26 +87912,26 @@ export interface components { ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. @@ -82003,168 +87946,195 @@ export interface components { web_commit_signoff_required?: boolean; } | null; sha: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; }; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ issue_url: string; labels: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; + /** @nullable */ description: string | null; id: number; /** @description The name of the label. */ name: string; node_id: string; /** - * Format: uri * @description URL for the label + * @format uri */ url: string; }[]; locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ maintainer_can_modify?: boolean; + /** @nullable */ merge_commit_sha: string | null; + /** @nullable */ mergeable?: boolean | null; mergeable_state?: string; + /** @nullable */ merged?: boolean | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ merged_at: string | null; - /** User */ + /** + * User + * @nullable + */ merged_by?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** * Milestone + * @nullable * @description A collection of related issues and pull requests. */ milestone: { - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ closed_at: string | null; closed_issues: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** User */ + /** + * User + * @nullable + */ creator: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ description: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ due_on: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ labels_url: string; node_id: string; /** @description The number of the milestone. */ @@ -82177,74 +88147,83 @@ export interface components { state: "open" | "closed"; /** @description The title of the milestone. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; } | null; node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ + /** @format uri */ patch_url: string; + /** @nullable */ rebaseable?: boolean | null; requested_reviewers: (({ - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null) | { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82253,12 +88232,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82266,36 +88245,43 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; })[]; requested_teams: { deleted?: boolean; - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description?: string | null; - /** Format: uri */ + /** @format uri */ html_url?: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url?: string; /** @description Name of the team */ name: string; node_id?: string; + /** @nullable */ parent?: { - /** @description Description of the team */ + /** + * @nullable + * @description Description of the team + */ description: string | null; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; /** @description Name of the team */ name: string; @@ -82304,12 +88290,12 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url: string; slug: string; /** - * Format: uri * @description URL for the team + * @format uri */ url: string; } | null; @@ -82317,69 +88303,73 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; - /** Format: uri */ + /** @format uri */ repositories_url?: string; slug?: string; /** - * Format: uri * @description URL for the team + * @format uri */ url?: string; }[]; - /** Format: uri-template */ + /** @format uri-template */ review_comment_url: string; review_comments?: number; - /** Format: uri */ + /** @format uri */ review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ state: "open" | "closed"; - /** Format: uri */ + /** @format uri */ statuses_url: string; /** @description The title of the pull request. */ title: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; - /** User */ + /** + * User + * @nullable + */ user: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82403,9 +88393,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82416,9 +88409,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82434,14 +88430,14 @@ export interface components { /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; }[]; @@ -82454,7 +88450,10 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ forced: boolean; - /** Commit */ + /** + * Commit + * @nullable + */ head_commit: { /** @description An array of files added in the commit. */ added?: string[]; @@ -82463,9 +88462,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82476,9 +88478,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -82494,14 +88499,14 @@ export interface components { /** @description An array of files removed in the commit. */ removed?: string[]; /** - * Format: date-time * @description The ISO 8601 timestamp of the commit. + * @format date-time */ timestamp: string; tree_id: string; /** - * Format: uri * @description URL that points to the commit API resource. + * @format uri */ url: string; } | null; @@ -82512,9 +88517,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ pusher: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email?: string | null; /** @description The git author's name. */ name: string; @@ -82550,32 +88558,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -82589,28 +88597,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -82638,89 +88647,104 @@ export interface components { * @default false */ has_discussions: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -82734,36 +88758,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -82781,7 +88807,9 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { + /** @nullable */ created_at: string | null; + /** @nullable */ description: string | null; ecosystem: string; html_url: string; @@ -82810,6 +88838,7 @@ export interface components { user_view_type?: string; }; package_type: string; + /** @nullable */ package_version: { author?: { avatar_url: string; @@ -82835,7 +88864,9 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { + /** @nullable */ labels?: Record | null; + /** @nullable */ manifest?: Record | null; tag?: { digest?: string; @@ -82856,22 +88887,27 @@ export interface components { [key: string]: unknown; }[]; name: string; + /** @nullable */ npm_metadata?: { name?: string; version?: string; npm_user?: string; + /** @nullable */ author?: (string | Record) | null; + /** @nullable */ bugs?: (string | Record) | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; + /** @nullable */ dist?: (string | Record) | null; git_head?: string; homepage?: string; license?: string; main?: string; + /** @nullable */ repository?: (string | Record) | null; scripts?: Record; id?: string; @@ -82885,6 +88921,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; + /** @nullable */ directories?: (string | Record) | null; os?: string[]; cpu?: string[]; @@ -82895,7 +88932,9 @@ export interface components { published_via_actions?: boolean; deleted_by_id?: number; } | null; + /** @nullable */ nuget_metadata?: { + /** @nullable */ id?: (string | Record | number) | null; name?: string; value?: boolean | string | number | { @@ -82910,11 +88949,15 @@ export interface components { created_at: string; download_url: string; id: number; + /** @nullable */ md5: string | null; name: string; + /** @nullable */ sha1: string | null; + /** @nullable */ sha256: string | null; size: number; + /** @nullable */ state: string | null; updated_at: string; }[]; @@ -82946,6 +88989,7 @@ export interface components { draft?: boolean; html_url?: string; id?: number; + /** @nullable */ name?: string | null; prerelease?: boolean; published_at?: string; @@ -82961,6 +89005,7 @@ export interface components { updated_at?: string; version: string; } | null; + /** @nullable */ registry: { about_url?: string; name?: string; @@ -82968,6 +89013,7 @@ export interface components { url?: string; vendor?: string; } | null; + /** @nullable */ updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; @@ -82981,6 +89027,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { created_at: string; + /** @nullable */ description: unknown; ecosystem: string; html_url: string; @@ -83052,8 +89099,10 @@ export interface components { created_at?: string; download_url?: string; id?: number; + /** @nullable */ md5?: string | null; name?: string; + /** @nullable */ sha1?: string | null; sha256?: string; size?: number; @@ -83103,6 +89152,7 @@ export interface components { updated_at: string; version: string; }; + /** @nullable */ registry: Record | null; updated_at: string; }; @@ -83169,13 +89219,14 @@ export interface components { */ release: { assets: ({ - /** Format: uri */ + /** @format uri */ browser_download_url: string; content_type: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; download_count: number; id: number; + /** @nullable */ label: string | null; /** @description The file name of the asset. */ name: string; @@ -83186,98 +89237,111 @@ export interface components { * @enum {string} */ state: "uploaded"; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** User */ + /** + * User + * @nullable + */ uploader?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; - /** Format: uri */ + /** @format uri */ assets_url: string; - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; + /** @nullable */ body: string | null; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ created_at: string | null; - /** Format: uri */ + /** @format uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ draft: boolean; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; + /** @nullable */ name: string | null; node_id: string; /** @@ -83285,7 +89349,10 @@ export interface components { * @enum {boolean} */ prerelease: true; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; /** Reactions */ reactions?: { @@ -83298,20 +89365,26 @@ export interface components { laugh: number; rocket: number; total_count: number; - /** Format: uri */ + /** @format uri */ url: string; }; /** @description The name of the tag. */ tag_name: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; - /** Format: uri-template */ + /** @format uri-template */ upload_url: string; - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -83407,7 +89480,10 @@ export interface components { /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ action: string; branch: string; - /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + /** + * @nullable + * @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + */ client_payload: { [key: string]: unknown; } | null; @@ -83426,12 +89502,15 @@ export interface components { from: string; }; description?: { + /** @nullable */ from: string | null; }; homepage?: { + /** @nullable */ from: string | null; }; topics?: { + /** @nullable */ from?: string[] | null; }; }; @@ -83577,65 +89656,70 @@ export interface components { from: { /** Organization */ organization?: { - /** Format: uri */ + /** @format uri */ avatar_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ events_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; - /** Format: uri */ + /** @format uri */ issues_url: string; login: string; - /** Format: uri-template */ + /** @format uri-template */ members_url: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ public_members_url: string; - /** Format: uri */ + /** @format uri */ repos_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** User */ + /** + * User + * @nullable + */ user?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; - /** Format: int64 */ + /** @format int64 */ id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -83681,52 +89765,60 @@ export interface components { affected_package_name: string; affected_range: string; created_at: string; + /** @nullable */ dismiss_comment?: string | null; dismiss_reason: string; dismissed_at: string; - /** User */ + /** + * User + * @nullable + */ dismisser: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -83768,48 +89860,55 @@ export interface components { created_at: string; dismiss_reason?: string; dismissed_at?: string; - /** User */ + /** + * User + * @nullable + */ dismisser?: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; external_identifier: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ external_reference: string | null; fix_reason?: string; - /** Format: date-time */ + /** @format date-time */ fixed_at?: string; fixed_in?: string; ghsa_id: string; @@ -83912,20 +90011,27 @@ export interface components { */ source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at: string; /** - * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at: string; - /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + /** + * @nullable + * @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates + */ secret_types?: string[] | null; - /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + /** + * @nullable + * @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated + */ custom_pattern_name?: string | null; /** + * @nullable * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated * @enum {string|null} */ @@ -83970,6 +90076,7 @@ export interface components { security_advisory: { cvss: { score: number; + /** @nullable */ vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; @@ -83985,13 +90092,14 @@ export interface components { }[]; published_at: string; references: { - /** Format: uri */ + /** @format uri */ url: string; }[]; severity: string; summary: string; updated_at: string; vulnerabilities: { + /** @nullable */ first_patched_version: { identifier: string; } | null; @@ -84104,7 +90212,10 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ starred_at: string | null; }; /** star deleted event */ @@ -84116,68 +90227,85 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; - /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ + /** + * @nullable + * @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. + */ starred_at: unknown; }; /** status event */ "webhook-status": { - /** Format: uri */ + /** + * @nullable + * @format uri + */ avatar_url?: string | null; /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */ branches: { commit: { + /** @nullable */ sha: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; }; name: string; protected: boolean; }[]; commit: { - /** User */ + /** + * User + * @nullable + */ author: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id?: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ comments_url: string; commit: { author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -84189,9 +90317,12 @@ export interface components { }; comment_count: number; committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -84204,74 +90335,84 @@ export interface components { message: string; tree: { sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ url: string; verification: { + /** @nullable */ payload: string | null; /** @enum {string} */ reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; + /** @nullable */ signature: string | null; verified: boolean; + /** @nullable */ verified_at?: string | null; }; }; - /** User */ + /** + * User + * @nullable + */ committer: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id?: number; login?: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ html_url: string; node_id: string; parents: { - /** Format: uri */ + /** @format uri */ html_url: string; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }[]; sha: string; - /** Format: uri */ + /** @format uri */ url: string; }; context: string; created_at: string; - /** @description The optional human-readable description added to the status. */ + /** + * @nullable + * @description The optional human-readable description added to the status. + */ description: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ @@ -84288,7 +90429,10 @@ export interface components { * @enum {string} */ state: "pending" | "success" | "failure" | "error"; - /** @description The optional link added to the status. */ + /** + * @nullable + * @description The optional link added to the status. + */ target_url: string | null; updated_at: string; }; @@ -84400,32 +90544,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84439,28 +90583,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84483,89 +90628,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84579,36 +90739,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -84653,32 +90815,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84692,28 +90854,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84736,89 +90899,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -84832,36 +91010,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -84906,32 +91086,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -84945,28 +91125,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -84989,89 +91170,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85085,36 +91281,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85190,32 +91388,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85229,28 +91427,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -85273,89 +91472,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85369,36 +91583,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85443,32 +91659,32 @@ export interface components { */ allow_squash_merge: boolean; allow_update_branch?: boolean; - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; /** * @description Whether the repository is archived. * @default false */ archived: boolean; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri */ + /** @format uri */ clone_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @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. */ @@ -85482,28 +91698,29 @@ export interface components { * @default false */ delete_branch_on_merge: boolean; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; /** @description Returns whether or not this repository is disabled. */ disabled?: boolean; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; forks: number; forks_count: number; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ git_url: string; /** * @description Whether downloads are enabled. @@ -85526,89 +91743,104 @@ export interface components { * @default true */ has_wiki: boolean; + /** @nullable */ homepage: string | null; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** - * Format: int64 * @description Unique identifier of the repository + * @format int64 */ id: number; is_template?: boolean; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; + /** @nullable */ language: string | null; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** License */ + /** + * License + * @nullable + */ license: { key: string; name: string; node_id: string; spdx_id: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ url: string | null; } | null; master_branch?: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ mirror_url: string | null; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; open_issues: number; open_issues_count: number; organization?: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; @@ -85622,36 +91854,38 @@ export interface components { /** @description Whether the repository is private or public. */ private: boolean; public?: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; + /** @nullable */ pushed_at: (number | string) | null; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; + /** @nullable */ role_name?: string | null; size: number; ssh_url: string; stargazers?: number; stargazers_count: number; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ svn_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; topics: string[]; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; /** @enum {string} */ visibility: "public" | "private" | "internal"; @@ -85674,6 +91908,7 @@ export interface components { /** workflow_dispatch event */ "webhook-workflow-dispatch": { enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @nullable */ inputs: { [key: string]: unknown; } | null; @@ -85694,15 +91929,19 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85711,15 +91950,27 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_name: string | null; started_at: string; /** @@ -85727,21 +91978,32 @@ export interface components { * @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "queued"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; @@ -85759,15 +92021,25 @@ export interface components { run_attempt?: number; run_id?: number; run_url?: string; + /** @nullable */ runner_group_id?: number | null; + /** @nullable */ runner_group_name?: string | null; + /** @nullable */ runner_id?: number | null; + /** @nullable */ runner_name?: string | null; started_at?: string; status?: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name?: string | null; steps?: (Record | null)[]; url?: string; @@ -85784,15 +92056,19 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | null | "cancelled" | "neutral"; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ @@ -85801,15 +92077,27 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; - /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_id: number | null; - /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_group_name: string | null; - /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_id: number | null; - /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ + /** + * @nullable + * @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. + */ runner_name: string | null; started_at: string; /** @@ -85817,25 +92105,38 @@ export interface components { * @enum {string} */ status: "queued" | "in_progress" | "completed"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | null | "cancelled"; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; } & { check_run_url?: string; + /** @nullable */ completed_at?: string | null; + /** @nullable */ conclusion?: string | null; /** @description The time that the job created. */ created_at?: string; @@ -85848,22 +92149,35 @@ export interface components { run_attempt?: number; run_id?: number; run_url?: string; + /** @nullable */ runner_group_id?: number | null; + /** @nullable */ runner_group_name?: string | null; + /** @nullable */ runner_id?: number | null; + /** @nullable */ runner_name?: string | null; started_at?: string; /** @enum {string} */ status: "in_progress" | "completed" | "queued"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch?: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name?: string | null; steps: { + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "in_progress" | "completed" | "pending" | "queued"; @@ -85882,14 +92196,16 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -85897,31 +92213,46 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; + /** @nullable */ runner_group_id: number | null; + /** @nullable */ runner_group_name: string | null; + /** @nullable */ runner_id: number | null; + /** @nullable */ runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; /** @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -85936,14 +92267,16 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; workflow_job: { - /** Format: uri */ + /** @format uri */ check_run_url: string; + /** @nullable */ completed_at: string | null; + /** @nullable */ conclusion: string | null; /** @description The time that the job created. */ created_at: string; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; labels: string[]; @@ -85951,31 +92284,46 @@ export interface components { node_id: string; run_attempt: number; run_id: number; - /** Format: uri */ + /** @format uri */ run_url: string; + /** @nullable */ runner_group_id: number | null; + /** @nullable */ runner_group_name: string | null; + /** @nullable */ runner_id: number | null; + /** @nullable */ runner_name: string | null; - /** Format: date-time */ + /** @format date-time */ started_at: string; - /** @description The name of the current branch. */ + /** + * @nullable + * @description The name of the current branch. + */ head_branch: string | null; - /** @description The name of the workflow. */ + /** + * @nullable + * @description The name of the workflow. + */ workflow_name: string | null; /** @enum {string} */ status: "queued" | "in_progress" | "completed" | "waiting"; steps: { + /** @nullable */ completed_at: string | null; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "failure" | "skipped" | "success" | "cancelled" | null; name: string; number: number; + /** @nullable */ started_at: string | null; /** @enum {string} */ status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; }[]; - /** Format: uri */ + /** @format uri */ url: string; }; deployment?: components["schemas"]["deployment"]; @@ -85992,57 +92340,65 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86051,9 +92407,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86064,9 +92423,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86079,143 +92441,152 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -86224,7 +92595,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -86235,16 +92606,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -86252,183 +92624,192 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. @@ -86449,56 +92830,64 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86507,9 +92896,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86520,9 +92912,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86535,142 +92930,154 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; - /** @description The name of the repository. */ + /** + * @nullable + * @description The name of the repository. + */ name: string | null; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: ({ base: { @@ -86679,7 +93086,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -86690,16 +93097,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; } | null)[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -86707,181 +93115,190 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; }; }; @@ -86897,57 +93314,65 @@ export interface components { workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { - /** User */ + /** + * User + * @nullable + */ actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: uri */ + /** @format uri */ artifacts_url: string; - /** Format: uri */ + /** @format uri */ cancel_url: string; check_suite_id: number; check_suite_node_id: string; - /** Format: uri */ + /** @format uri */ check_suite_url: string; - /** @enum {string|null} */ + /** + * @nullable + * @enum {string|null} + */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ + /** @format date-time */ created_at: string; event: string; + /** @nullable */ head_branch: string | null; /** SimpleCommit */ head_commit: { @@ -86956,9 +93381,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ author: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86969,9 +93397,12 @@ export interface components { * @description Metaproperties for Git author/committer information. */ committer: { - /** Format: date-time */ + /** @format date-time */ date?: string; - /** Format: email */ + /** + * @nullable + * @format email + */ email: string | null; /** @description The git author's name. */ name: string; @@ -86984,143 +93415,152 @@ export interface components { }; /** Repository Lite */ head_repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; head_sha: string; - /** Format: uri */ + /** @format uri */ html_url: string; id: number; - /** Format: uri */ + /** @format uri */ jobs_url: string; - /** Format: uri */ + /** @format uri */ logs_url: string; + /** @nullable */ name: string | null; node_id: string; path: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ previous_attempt_url: string | null; pull_requests: { base: { @@ -87129,7 +93569,7 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; @@ -87140,16 +93580,17 @@ export interface components { repo: { id: number; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; sha: string; }; id: number; number: number; - /** Format: uri */ + /** @format uri */ url: string; }[]; + /** @nullable */ referenced_workflows?: { path: string; ref?: string; @@ -87157,183 +93598,192 @@ export interface components { }[] | null; /** Repository Lite */ repository: { - /** Format: uri-template */ + /** @format uri-template */ archive_url: string; - /** Format: uri-template */ + /** @format uri-template */ assignees_url: string; - /** Format: uri-template */ + /** @format uri-template */ blobs_url: string; - /** Format: uri-template */ + /** @format uri-template */ branches_url: string; - /** Format: uri-template */ + /** @format uri-template */ collaborators_url: string; - /** Format: uri-template */ + /** @format uri-template */ comments_url: string; - /** Format: uri-template */ + /** @format uri-template */ commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ compare_url: string; - /** Format: uri-template */ + /** @format uri-template */ contents_url: string; - /** Format: uri */ + /** @format uri */ contributors_url: string; - /** Format: uri */ + /** @format uri */ deployments_url: string; + /** @nullable */ description: string | null; - /** Format: uri */ + /** @format uri */ downloads_url: string; - /** Format: uri */ + /** @format uri */ events_url: string; fork: boolean; - /** Format: uri */ + /** @format uri */ forks_url: string; full_name: string; - /** Format: uri-template */ + /** @format uri-template */ git_commits_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_refs_url: string; - /** Format: uri-template */ + /** @format uri-template */ git_tags_url: string; - /** Format: uri */ + /** @format uri */ hooks_url: string; - /** Format: uri */ + /** @format uri */ html_url: string; /** @description Unique identifier of the repository */ id: number; - /** Format: uri-template */ + /** @format uri-template */ issue_comment_url: string; - /** Format: uri-template */ + /** @format uri-template */ issue_events_url: string; - /** Format: uri-template */ + /** @format uri-template */ issues_url: string; - /** Format: uri-template */ + /** @format uri-template */ keys_url: string; - /** Format: uri-template */ + /** @format uri-template */ labels_url: string; - /** Format: uri */ + /** @format uri */ languages_url: string; - /** Format: uri */ + /** @format uri */ merges_url: string; - /** Format: uri-template */ + /** @format uri-template */ milestones_url: string; /** @description The name of the repository. */ name: string; node_id: string; - /** Format: uri-template */ + /** @format uri-template */ notifications_url: string; - /** User */ + /** + * User + * @nullable + */ owner: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; - /** Format: uri-template */ + /** @format uri-template */ pulls_url: string; - /** Format: uri-template */ + /** @format uri-template */ releases_url: string; - /** Format: uri */ + /** @format uri */ stargazers_url: string; - /** Format: uri-template */ + /** @format uri-template */ statuses_url: string; - /** Format: uri */ + /** @format uri */ subscribers_url: string; - /** Format: uri */ + /** @format uri */ subscription_url: string; - /** Format: uri */ + /** @format uri */ tags_url: string; - /** Format: uri */ + /** @format uri */ teams_url: string; - /** Format: uri-template */ + /** @format uri-template */ trees_url: string; - /** Format: uri */ + /** @format uri */ url: string; }; - /** Format: uri */ + /** @format uri */ rerun_url: string; run_attempt: number; run_number: number; - /** Format: date-time */ + /** @format date-time */ run_started_at: string; /** @enum {string} */ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; - /** User */ + /** + * User + * @nullable + */ triggering_actor: { - /** Format: uri */ + /** @format uri */ avatar_url?: string; deleted?: boolean; + /** @nullable */ email?: string | null; - /** Format: uri-template */ + /** @format uri-template */ events_url?: string; - /** Format: uri */ + /** @format uri */ followers_url?: string; - /** Format: uri-template */ + /** @format uri-template */ following_url?: string; - /** Format: uri-template */ + /** @format uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ + /** @format uri */ html_url?: string; id: number; login: string; name?: string; node_id?: string; - /** Format: uri */ + /** @format uri */ organizations_url?: string; - /** Format: uri */ + /** @format uri */ received_events_url?: string; - /** Format: uri */ + /** @format uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + /** @format uri-template */ starred_url?: string; - /** Format: uri */ + /** @format uri */ subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization"; - /** Format: uri */ + /** @format uri */ url?: string; user_view_type?: string; } | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: uri */ + /** @format uri */ url: string; workflow_id: number; - /** Format: uri */ + /** @format uri */ workflow_url: string; display_title: string; }; @@ -87450,6 +93900,7 @@ export interface components { block?: { reason?: string; created_at?: string; + /** @nullable */ html_url?: string | null; }; message?: string; @@ -88237,6 +94688,7 @@ export interface operations { "application/json": components["schemas"]["integration"] & ({ client_id: string; client_secret: string; + /** @nullable */ webhook_secret: string | null; pem: string; } & { @@ -89824,7 +96276,10 @@ export interface operations { [key: string]: { /** @description The new content of the file. */ content?: string; - /** @description The new filename for the file. */ + /** + * @nullable + * @description The new filename for the file. + */ filename?: string | null; } | null; }; @@ -90760,8 +97215,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at?: string; /** @description Whether the notification has been read. */ @@ -91359,7 +97814,10 @@ export interface operations { * @enum {string} */ source?: "github" | "partner" | "custom"; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ version?: string | null; }; /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ @@ -91586,7 +98044,10 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; - /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + /** + * @nullable + * @description The version of the runner image to deploy. This is relevant only for runners using custom images. + */ image_version?: string | null; }; }; @@ -92076,7 +98537,10 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; - /** @description The identifier of a hosted compute network configuration. */ + /** + * @nullable + * @description The identifier of a hosted compute network configuration. + */ network_configuration_id?: string | null; }; }; @@ -92742,7 +99206,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -94183,7 +100650,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; @@ -94877,7 +101347,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -97426,7 +103899,10 @@ export interface operations { * @enum {string} */ action: "approve" | "deny"; - /** @description Reason for approving or denying the requests. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the requests. Max 1024 characters. + */ reason?: string | null; }; }; @@ -97459,7 +103935,10 @@ export interface operations { * @enum {string} */ action: "approve" | "deny"; - /** @description Reason for approving or denying the request. Max 1024 characters. */ + /** + * @nullable + * @description Reason for approving or denying the request. Max 1024 characters. + */ reason?: string | null; }; }; @@ -97701,9 +104180,15 @@ export interface operations { * @enum {string} */ registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ key_id: string; @@ -97838,9 +104323,15 @@ export interface operations { * @enum {string} */ registry_type?: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + /** + * @nullable + * @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + */ username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + /** + * @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; @@ -99362,7 +105853,10 @@ export interface operations { * @enum {string} */ permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ parent_team_id?: number | null; }; }; @@ -100547,6 +107041,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100592,6 +107087,7 @@ export interface operations { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom + * @pattern ^(?:top|bottom|after:\d+)$ */ position: string; /** @@ -100787,6 +107283,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description The project card's note * @example Update all gems */ @@ -100862,6 +107359,7 @@ export interface operations { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last + * @pattern ^(?:first|last|after:\d+)$ */ position: string; }; @@ -100966,6 +107464,7 @@ export interface operations { */ name?: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -101347,6 +107846,7 @@ export interface operations { */ visibility?: "public" | "private"; /** + * @nullable * @description Specify which security and analysis features to enable or disable for the repository. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -103265,7 +109765,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -104224,7 +110727,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Require status checks to pass before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require status checks to pass before merging. Set to `null` to disable. + */ required_status_checks: { /** @description Require branches to be up to date before merging. */ strict: boolean; @@ -104241,9 +110747,15 @@ export interface operations { app_id?: number; }[]; } | null; - /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ + /** + * @nullable + * @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ enforce_admins: boolean | null; - /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ + /** + * @nullable + * @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ required_pull_request_reviews: { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { @@ -104275,7 +110787,10 @@ export interface operations { apps?: string[]; }; } | null; - /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ + /** + * @nullable + * @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ restrictions: { /** @description The list of user `login`s with push access */ users: string[]; @@ -104286,7 +110801,10 @@ export interface operations { } | null; /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ required_linear_history?: boolean; - /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + /** + * @nullable + * @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ allow_force_pushes?: boolean | null; /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ allow_deletions?: boolean; @@ -105382,8 +111900,8 @@ export interface operations { */ status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** - * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @@ -105393,8 +111911,8 @@ export interface operations { */ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -105524,8 +112042,8 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ external_id?: string; /** - * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @@ -105540,8 +112058,8 @@ export interface operations { */ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** - * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ @@ -106560,15 +113078,15 @@ export interface operations { ref: components["schemas"]["code-scanning-ref-full"]; sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** - * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ + * @format uri */ checkout_uri?: string; /** - * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ @@ -106927,6 +113445,7 @@ export interface operations { billable_owner?: components["schemas"]["simple-user"]; defaults?: { location: string; + /** @nullable */ devcontainer_path: string | null; }; }; @@ -107075,7 +113594,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -108470,7 +114992,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -108697,6 +115222,7 @@ export interface operations { */ environment?: string; /** + * @nullable * @description Short description of the deployment. * @default */ @@ -109046,7 +115572,10 @@ export interface operations { "application/json": { wait_timer?: components["schemas"]["wait-timer"]; prevent_self_review?: components["schemas"]["prevent-self-review"]; - /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ + /** + * @nullable + * @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + */ reviewers?: { type?: components["schemas"]["deployment-reviewer-type"]; /** @@ -109552,7 +116081,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -109982,8 +116514,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -109994,8 +116526,8 @@ export interface operations { /** @description The email of the author (or committer) of the commit */ email?: string; /** - * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -110259,8 +116791,8 @@ export interface operations { /** @description The email of the author of the tag */ email: string; /** - * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ date?: string; }; @@ -110341,6 +116873,7 @@ export interface operations { */ type?: "blob" | "tree" | "commit"; /** + * @nullable * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. @@ -111364,14 +117897,20 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ + /** + * @nullable + * @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ + */ assignee?: string | null; + /** @nullable */ milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ labels?: (string | { id?: number; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ @@ -111745,11 +118284,20 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The title of the issue. */ + /** + * @nullable + * @description The title of the issue. + */ title?: (string | number) | null; - /** @description The contents of the issue. */ + /** + * @nullable + * @description The contents of the issue. + */ body?: string | null; - /** @description Username to assign to this issue. **This field is closing down.** */ + /** + * @nullable + * @description Username to assign to this issue. **This field is closing down.** + */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -111757,17 +118305,21 @@ export interface operations { */ state?: "open" | "closed"; /** + * @nullable * @description The reason for the state change. Ignored unless `state` is changed. * @example not_planned * @enum {string|null} */ state_reason?: "completed" | "not_planned" | "reopened" | null; + /** @nullable */ milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ labels?: (string | { id?: number; name?: string; + /** @nullable */ description?: string | null; + /** @nullable */ color?: string | null; })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ @@ -113073,8 +119625,8 @@ export interface operations { /** @description A description of the milestone. */ description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on?: string; }; @@ -113178,8 +119730,8 @@ export interface operations { /** @description A description of the milestone. */ description?: string; /** - * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ due_on?: string; }; @@ -113285,8 +119837,8 @@ export interface operations { content: { "application/json": { /** - * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * @format date-time */ last_read_at?: string; }; @@ -113355,7 +119907,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ + /** + * @nullable + * @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." + */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -113981,9 +120536,9 @@ export interface operations { /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ head: string; /** - * Format: repo.nwo * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. * @example octo-org/octo-repo + * @format repo.nwo */ head_repo?: string; /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ @@ -113995,9 +120550,9 @@ export interface operations { /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ draft?: boolean; /** - * Format: int64 * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. * @example 1 + * @format int64 */ issue?: number; }; @@ -116844,12 +123399,16 @@ export interface operations { */ state: "error" | "failure" | "pending" | "success"; /** + * @nullable * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; - /** @description A short description of the status. */ + /** + * @nullable + * @description A short description of the status. + */ description?: string | null; /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. @@ -117915,7 +124474,10 @@ export interface operations { * @enum {string} */ permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ + /** + * @nullable + * @description The ID of a team to set as the parent team. + */ parent_team_id?: number | null; }; }; @@ -118999,6 +125561,7 @@ export interface operations { */ blog?: string; /** + * @nullable * @description The new Twitter username of the user. * @example therealomarj */ @@ -119358,7 +125921,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ + /** + * @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. + * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -120489,7 +127055,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. */ + /** + * @description The public SSH key to add to your GitHub account. + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) + */ key: string; }; }; @@ -121228,6 +127797,7 @@ export interface operations { */ name: string; /** + * @nullable * @description Body of the project * @example This project represents the sprint of the first week in January */ @@ -121720,7 +128290,10 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** + * @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + * @pattern ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com + */ key: string; }; }; diff --git a/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts b/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts index 3d688f2f8..d9c42a023 100644 --- a/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts +++ b/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts @@ -2531,13 +2531,15 @@ export interface components { "public-key-full": { id: number; key: string; + /** @nullable */ user_id: number | null; + /** @nullable */ repository_id: number | null; url: string; title: string; read_only: boolean; verified: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; }; "ldap-mapping-team": { @@ -2548,11 +2550,13 @@ export interface components { html_url?: string; name?: string; slug?: string; + /** @nullable */ description?: string | null; privacy?: string; permission?: string; members_url?: string; repositories_url?: string; + /** @nullable */ parent?: unknown; }; /** @@ -2568,25 +2572,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -2596,47 +2603,67 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ type: string; site_admin: boolean; - /** @example monalisa octocat */ + /** + * @nullable + * @example monalisa octocat + */ name: string | null; - /** @example GitHub */ + /** + * @nullable + * @example GitHub + */ company: string | null; - /** @example https://github.com/blog */ + /** + * @nullable + * @example https://github.com/blog + */ blog: string | null; - /** @example San Francisco */ + /** + * @nullable + * @example San Francisco + */ location: string | null; /** - * Format: email + * @nullable * @example octocat@github.com + * @format email */ email: string | null; + /** @nullable */ hireable: boolean | null; - /** @example There once was... */ + /** + * @nullable + * @example There once was... + */ bio: string | null; - /** @example monalisa */ + /** + * @nullable + * @example monalisa + */ twitter_username?: string | null; /** @example 2 */ public_repos: number; @@ -2647,13 +2674,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ updated_at: string; /** @example 81 */ @@ -2674,7 +2701,10 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at?: string | null; business_plus?: boolean; }; @@ -2690,18 +2720,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -2714,7 +2744,10 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; }; "pre-receive-environment": { @@ -2729,14 +2762,18 @@ export interface components { download?: { url?: string; state?: string; + /** @nullable */ downloaded_at?: string | null; + /** @nullable */ message?: string | null; }; }; "pre-receive-environment-download-status": { url?: string; state?: string; + /** @nullable */ downloaded_at?: string | null; + /** @nullable */ message?: string | null; }; "pre-receive-hook": { @@ -2762,7 +2799,9 @@ export interface components { download?: { url?: string; state?: string; + /** @nullable */ downloaded_at?: string | null; + /** @nullable */ message?: string | null; }; }; @@ -2774,30 +2813,43 @@ export interface components { */ authorization: { id: number; - /** Format: uri */ + /** @format uri */ url: string; - /** @description A list of scopes that this authorization is in. */ + /** + * @nullable + * @description A list of scopes that this authorization is in. + */ scopes: string[] | null; token: string; + /** @nullable */ token_last_eight: string | null; + /** @nullable */ hashed_token: string | null; app: { client_id: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; + /** @nullable */ note: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ note_url: string | null; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** Format: date-time */ + /** @format date-time */ created_at: string; + /** @nullable */ fingerprint: string | null; user?: components["schemas"]["nullable-simple-user"]; installation?: components["schemas"]["nullable-scoped-installation"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ expires_at: string | null; }; /** @@ -2805,7 +2857,9 @@ export interface components { * @description Simple User */ "simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; @@ -2814,25 +2868,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -2842,25 +2899,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -2879,6 +2936,7 @@ export interface components { * @example 1 */ id: number; + /** @nullable */ account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; /** * @description Describe whether all repositories have been selected or there's a selection involved @@ -2886,18 +2944,18 @@ export interface components { */ repository_selection: "all" | "selected"; /** - * Format: uri * @example https://api.github.com/installations/1/access_tokens + * @format uri */ access_tokens_url: string; /** - * Format: uri * @example https://api.github.com/installation/repositories + * @format uri */ repositories_url: string; /** - * Format: uri * @example https://github.com/organizations/github/settings/installations/1 + * @format uri */ html_url: string; /** @example 1 */ @@ -2908,11 +2966,14 @@ export interface components { target_type: string; permissions: components["schemas"]["app-permissions"]; events: string[]; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -2926,9 +2987,15 @@ export interface components { /** @example github-actions */ app_slug: string; suspended_by: components["schemas"]["nullable-simple-user"]; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ suspended_at: string | null; - /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ + /** + * @nullable + * @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" + */ contact_email?: string | null; }; /** @@ -3124,24 +3191,24 @@ export interface components { /** @example 1 */ id: number; /** - * Format: uri * @example https://api.github.com/applications/grants/1 + * @format uri */ url: string; app: { client_id: string; name: string; - /** Format: uri */ + /** @format uri */ url: string; }; /** - * Format: date-time * @example 2011-09-06T17:26:27Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-09-06T20:39:23Z + * @format date-time */ updated_at: string; /** @@ -3332,15 +3399,16 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; @@ -3354,12 +3422,16 @@ export interface components { /** @description The secret that was detected. */ secret?: string; repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; }; @@ -3410,18 +3482,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -3434,25 +3506,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -3469,13 +3547,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** @example Organization */ @@ -3484,15 +3562,25 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; - /** @example 8 */ + /** + * @nullable + * @example 8 + */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -3502,10 +3590,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -3521,11 +3616,14 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** @@ -3696,14 +3794,14 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** @@ -3713,7 +3811,10 @@ export interface components { name: string; /** @example justice-league */ slug: string; - /** @example A great team. */ + /** + * @nullable + * @example A great team. + */ description: string | null; /** * @description The level of privacy this team should have @@ -3729,8 +3830,8 @@ export interface components { /** @example https://api.github.com/organizations/1/team/1/members{/member} */ members_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; parent?: components["schemas"]["nullable-team-simple"]; @@ -3739,13 +3840,13 @@ export interface components { /** @example 10 */ repos_count: number; /** - * Format: date-time * @example 2017-07-14T16:53:42Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2017-08-17T12:37:15Z + * @format date-time */ updated_at: string; organization: components["schemas"]["team-organization"]; @@ -3794,6 +3895,7 @@ export interface components { */ id: number; /** + * @nullable * @description The name of the workflow run. * @example Build */ @@ -3810,7 +3912,10 @@ export interface components { * @example MDEwOkNoZWNrU3VpdGU0Mg== */ check_suite_node_id?: string; - /** @example master */ + /** + * @nullable + * @example master + */ head_branch: string | null; /** * @description The SHA of the head commit that points to the version of the workflow being run. @@ -3832,12 +3937,19 @@ export interface components { * @example 1 */ run_attempt?: number; + /** @nullable */ referenced_workflows?: components["schemas"]["referenced-workflow"][] | null; /** @example push */ event: string; - /** @example completed */ + /** + * @nullable + * @example completed + */ status: string | null; - /** @example neutral */ + /** + * @nullable + * @example neutral + */ conclusion: string | null; /** * @description The ID of the parent workflow. @@ -3851,16 +3963,17 @@ export interface components { url: string; /** @example https://github.com/github/hello-world/suites/4 */ html_url: string; + /** @nullable */ pull_requests: components["schemas"]["pull-request-minimal"][] | null; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; actor?: components["schemas"]["simple-user"]; triggering_actor?: components["schemas"]["simple-user"]; /** - * Format: date-time * @description The start time of the latest run. Resets on re-run. + * @format date-time */ run_started_at?: string; /** @@ -3894,6 +4007,7 @@ export interface components { */ rerun_url: string; /** + * @nullable * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ @@ -3971,30 +4085,35 @@ export interface components { login: string; /** @example 1 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -4004,25 +4123,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -4063,11 +4182,20 @@ export interface components { name: string; /** @example 1.0.0 */ version: string; - /** @example pkg:/npm/%40actions/core@1.1.0 */ + /** + * @nullable + * @example pkg:/npm/%40actions/core@1.1.0 + */ package_url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ license: string | null; - /** @example https://github.com/github/actions */ + /** + * @nullable + * @example https://github.com/github/actions + */ source_repository_url: string | null; vulnerabilities: { /** @example critical */ @@ -4096,16 +4224,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -4127,28 +4258,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -4170,13 +4301,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -4190,30 +4321,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -4221,25 +4352,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -4285,18 +4419,18 @@ export interface components { */ visibility?: string; /** - * Format: date-time * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string; /** - * Format: date-time * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string; /** - * Format: date-time * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string; permissions?: { @@ -4309,6 +4443,7 @@ export interface components { /** @example true */ allow_rebase_merge?: boolean; template_repository?: components["schemas"]["nullable-repository"]; + /** @nullable */ temp_clone_token?: string | null; /** @example true */ allow_squash_merge?: boolean; @@ -4408,16 +4543,22 @@ export interface components { * @description A release. */ release: { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ html_url: string; - /** Format: uri */ + /** @format uri */ assets_url: string; upload_url: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ tarball_url: string | null; - /** Format: uri */ + /** + * @nullable + * @format uri + */ zipball_url: string | null; id: number; node_id: string; @@ -4431,7 +4572,9 @@ export interface components { * @example master */ target_commitish: string; + /** @nullable */ name: string | null; + /** @nullable */ body?: string | null; /** * @description true to create a draft (unpublished) release, false to create a published one. @@ -4443,9 +4586,12 @@ export interface components { * @example false */ prerelease: boolean; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** + * @nullable + * @format date-time + */ published_at: string | null; author: components["schemas"]["simple-user"]; assets: components["schemas"]["release-asset"][]; @@ -4461,15 +4607,16 @@ export interface components { url?: components["schemas"]["alert-url"]; html_url?: components["schemas"]["alert-html-url"]; /** - * Format: uri * @description The REST API URL of the code locations for this alert. + * @format uri */ locations_url?: string; state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** - * Format: date-time + * @nullable * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ resolved_at?: string | null; resolved_by?: components["schemas"]["nullable-simple-user"]; @@ -4482,12 +4629,16 @@ export interface components { secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; - /** @description Whether push protection was bypassed for the detected secret. */ + /** + * @nullable + * @description Whether push protection was bypassed for the detected secret. + */ push_protection_bypassed?: boolean | null; push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** - * Format: date-time + * @nullable * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ push_protection_bypassed_at?: string | null; }; @@ -4497,6 +4648,7 @@ export interface components { */ "secret-scanning-alert-state": "open" | "resolved"; /** + * @nullable * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. * @enum {string|null} */ @@ -4517,16 +4669,19 @@ export interface components { owner: components["schemas"]["simple-user"]; private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -4548,28 +4703,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -4590,13 +4745,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -4609,43 +4764,46 @@ export interface components { releases_url: string; ssh_url?: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ trees_url: string; clone_url?: string; + /** @nullable */ mirror_url?: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; svn_url?: string; + /** @nullable */ homepage?: string | null; + /** @nullable */ language?: string | null; forks_count?: number; stargazers_count?: number; @@ -4665,18 +4823,21 @@ export interface components { disabled?: boolean; visibility?: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at?: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at?: string | null; permissions?: { @@ -4694,6 +4855,7 @@ export interface components { subscribers_count?: number; network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; + /** @nullable */ license?: { key?: string; name?: string; @@ -4719,6 +4881,7 @@ export interface components { Resources: { schemas: string[]; id: string; + /** @nullable */ externalId?: string | null; displayName?: string; members?: { @@ -4737,6 +4900,7 @@ export interface components { "scim-enterprise-group": { schemas: string[]; id: string; + /** @nullable */ externalId?: string | null; displayName?: string; members?: { @@ -4830,9 +4994,11 @@ export interface components { signup_enabled?: boolean; github_hostname?: string; identicons_host?: string; + /** @nullable */ http_proxy?: string | null; auth_mode?: string; expire_sessions?: boolean; + /** @nullable */ admin_password?: string | null; configuration_id?: number; configuration_run_count?: number; @@ -4859,19 +5025,26 @@ export interface components { }; github_ssl?: { enabled?: boolean; + /** @nullable */ cert?: string | null; + /** @nullable */ key?: string | null; }; ldap?: { + /** @nullable */ host?: string | null; port?: number; base?: unknown[]; + /** @nullable */ uid?: string | null; + /** @nullable */ bind_dn?: string | null; + /** @nullable */ password?: string | null; method?: string; search_strategy?: string; user_groups?: unknown[]; + /** @nullable */ admin_group?: string | null; virtual_attribute_enabled?: boolean; recursive_group_search?: boolean; @@ -4882,23 +5055,33 @@ export interface components { team_sync_interval?: number; sync_enabled?: boolean; reconciliation?: { + /** @nullable */ user?: string | null; + /** @nullable */ org?: string | null; }; profile?: { uid?: string; + /** @nullable */ name?: string | null; + /** @nullable */ mail?: string | null; + /** @nullable */ key?: string | null; }; }; cas?: { + /** @nullable */ url?: string | null; }; saml?: { + /** @nullable */ sso_url?: string | null; + /** @nullable */ certificate?: string | null; + /** @nullable */ certificate_path?: string | null; + /** @nullable */ issuer?: string | null; idp_initiated_sso?: boolean; disable_admin_demote?: boolean; @@ -4928,6 +5111,7 @@ export interface components { primary_server?: string; secondary_server?: string; }; + /** @nullable */ timezone?: string | null; snmp?: { enabled?: boolean; @@ -4935,27 +5119,36 @@ export interface components { }; syslog?: { enabled?: boolean; + /** @nullable */ server?: string | null; protocol_name?: string; }; + /** @nullable */ assets?: string | null; pages?: { enabled?: boolean; }; collectd?: { enabled?: boolean; + /** @nullable */ server?: string | null; port?: number; + /** @nullable */ encryption?: string | null; + /** @nullable */ username?: string | null; + /** @nullable */ password?: string | null; }; mapping?: { enabled?: boolean; + /** @nullable */ tileserver?: string | null; basemap?: string; + /** @nullable */ token?: string | null; }; + /** @nullable */ load_balancer?: string | null; }; run_list?: string[]; @@ -4966,10 +5159,13 @@ export interface components { }; /** * Simple User + * @nullable * @description Simple User */ "nullable-simple-user": { + /** @nullable */ name?: string | null; + /** @nullable */ email?: string | null; /** @example octocat */ login: string; @@ -4978,25 +5174,28 @@ export interface components { /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -5006,25 +5205,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -5033,7 +5232,10 @@ export interface components { /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; } | null; - /** Scoped Installation */ + /** + * Scoped Installation + * @nullable + */ "nullable-scoped-installation": { permissions: components["schemas"]["app-permissions"]; /** @@ -5041,7 +5243,10 @@ export interface components { * @enum {string} */ repository_selection: "all" | "selected"; - /** @example config.yaml */ + /** + * @nullable + * @example config.yaml + */ single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; @@ -5053,8 +5258,8 @@ export interface components { */ single_file_paths?: string[]; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repositories_url: string; account: components["schemas"]["simple-user"]; @@ -5064,16 +5269,20 @@ export interface components { * @description An enterprise account */ enterprise: { - /** @description A short description of the enterprise. */ + /** + * @nullable + * @description A short description of the enterprise. + */ description?: string | null; /** - * Format: uri * @example https://github.com/enterprises/octo-business + * @format uri */ html_url: string; /** - * Format: uri + * @nullable * @description The enterprise's website URL. + * @format uri */ website_url?: string | null; /** @@ -5094,16 +5303,18 @@ export interface components { */ slug: string; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2019-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; - /** Format: uri */ + /** @format uri */ avatar_url: string; }; /** @@ -5152,16 +5363,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -5183,28 +5397,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -5226,13 +5440,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -5246,30 +5460,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -5277,25 +5491,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -5360,18 +5577,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -5380,6 +5600,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id?: number; node_id?: string; @@ -5614,6 +5835,7 @@ export interface components { }; /** * License Simple + * @nullable * @description License Simple */ "nullable-license-simple": { @@ -5622,15 +5844,19 @@ export interface components { /** @example MIT License */ name: string; /** - * Format: uri + * @nullable * @example https://api.github.com/licenses/mit + * @format uri */ url: string | null; - /** @example MIT */ + /** + * @nullable + * @example MIT + */ spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ node_id: string; - /** Format: uri */ + /** @format uri */ html_url?: string; } | null; /** @@ -5639,31 +5865,33 @@ export interface components { */ "announcement-message": string; /** - * Format: date-time + * @nullable * @description The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string. * @example "2021-01-01T00:00:00.000-07:00" + * @format date-time */ "announcement-expiration": string | null; /** @description The security alert number. */ "alert-number": number; /** - * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-created-at": string; /** - * Format: date-time + * @nullable * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "nullable-alert-updated-at": string | null; /** - * Format: uri * @description The REST API URL of the alert resource. + * @format uri */ "alert-url": string; /** - * Format: uri * @description The GitHub URL of the alert resource. + * @format uri */ "alert-html-url": string; /** @@ -5695,12 +5923,13 @@ export interface components { /** @description Whether the repository is private. */ private: boolean; /** - * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; /** + * @nullable * @description The repository description. * @example This your first repo! */ @@ -5708,9 +5937,9 @@ export interface components { /** @description Whether the repository is a fork. */ fork: boolean; /** - * Format: uri * @description The URL to get more information about the repository from the GitHub API. * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @@ -5759,33 +5988,33 @@ export interface components { */ contents_url: string; /** - * Format: uri * @description A template for the API URL to list the contributors to the repository. * @example https://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @description The API URL to list the deployments of the repository. * @example https://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @description The API URL to list the downloads on the repository. * @example https://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @description The API URL to list the events of the repository. * @example https://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @description The API URL to list the forks of the repository. * @example https://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @@ -5829,15 +6058,15 @@ export interface components { */ labels_url: string; /** - * Format: uri * @description The API URL to get information about the languages of the repository. * @example https://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @description The API URL to merge branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @@ -5861,9 +6090,9 @@ export interface components { */ releases_url: string; /** - * Format: uri * @description The API URL to list the stargazers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @@ -5872,27 +6101,27 @@ export interface components { */ statuses_url: string; /** - * Format: uri * @description The API URL to list the subscribers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @description The API URL to subscribe to notifications for this repository. * @example https://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @description The API URL to get information about tags on the repository. * @example https://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @description The API URL to list the teams on the repository. * @example https://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @@ -5901,14 +6130,15 @@ export interface components { */ trees_url: string; /** - * Format: uri * @description The API URL to list the hooks on the repository. * @example https://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; }; /** * Team Simple + * @nullable * @description Groups of organization members that gives permissions on specified repositories. */ "nullable-team-simple": { @@ -5920,9 +6150,9 @@ export interface components { /** @example MDQ6VGVhbTE= */ node_id: string; /** - * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 + * @format uri */ url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ @@ -5933,6 +6163,7 @@ export interface components { */ name: string; /** + * @nullable * @description Description of the team * @example A great team. */ @@ -5948,13 +6179,13 @@ export interface components { */ privacy?: string; /** - * Format: uri * @example https://github.com/orgs/rails/teams/core + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/organizations/1/team/1/repos + * @format uri */ repositories_url: string; /** @example justice-league */ @@ -5977,18 +6208,18 @@ export interface components { /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ node_id: string; /** - * Format: uri * @example https://api.github.com/orgs/github + * @format uri */ url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/repos + * @format uri */ repos_url: string; /** - * Format: uri * @example https://api.github.com/orgs/github/events + * @format uri */ events_url: string; /** @example https://api.github.com/orgs/github/hooks */ @@ -6001,25 +6232,31 @@ export interface components { public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ avatar_url: string; - /** @example A great organization */ + /** + * @nullable + * @example A great organization + */ description: string | null; /** @example github */ name?: string; /** @example GitHub */ company?: string; /** - * Format: uri * @example https://github.com/blog + * @format uri */ blog?: string; /** @example San Francisco */ location?: string; /** - * Format: email * @example octocat@github.com + * @format email */ email?: string; - /** @example github */ + /** + * @nullable + * @example github + */ twitter_username?: string | null; /** @example true */ is_verified?: boolean; @@ -6036,13 +6273,13 @@ export interface components { /** @example 0 */ following: number; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: date-time * @example 2008-01-14T04:33:35Z + * @format date-time */ created_at: string; /** @example Organization */ @@ -6051,15 +6288,25 @@ export interface components { total_private_repos?: number; /** @example 100 */ owned_private_repos?: number; - /** @example 81 */ + /** + * @nullable + * @example 81 + */ private_gists?: number | null; - /** @example 10000 */ + /** + * @nullable + * @example 10000 + */ disk_usage?: number | null; - /** @example 8 */ + /** + * @nullable + * @example 8 + */ collaborators?: number | null; /** - * Format: email + * @nullable * @example org@example.com + * @format email */ billing_email?: string | null; plan?: { @@ -6069,10 +6316,17 @@ export interface components { filled_seats?: number; seats?: number; }; + /** @nullable */ default_repository_permission?: string | null; - /** @example true */ + /** + * @nullable + * @example true + */ members_can_create_repositories?: boolean | null; - /** @example true */ + /** + * @nullable + * @example true + */ two_factor_requirement_enabled?: boolean | null; /** @example all */ members_allowed_repository_creation_type?: string; @@ -6088,11 +6342,14 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; - /** @example false */ + /** + * @nullable + * @example false + */ members_can_fork_private_repositories?: boolean | null; /** @example false */ web_commit_signoff_required?: boolean; - /** Format: date-time */ + /** @format date-time */ updated_at: string; }; /** Rate Limit */ @@ -6137,18 +6394,21 @@ export interface components { }; /** * Simple Commit + * @nullable * @description Simple Commit */ "nullable-simple-commit": { id: string; tree_id: string; message: string; - /** Format: date-time */ + /** @format date-time */ timestamp: string; + /** @nullable */ author: { name: string; email: string; } | null; + /** @nullable */ committer: { name: string; email: string; @@ -6156,9 +6416,15 @@ export interface components { } | null; /** @description The name of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-name": string; - /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + /** + * @nullable + * @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. + */ "code-scanning-analysis-tool-guid": string | null; - /** @description The SHA of the commit to which the analysis you are uploading relates. */ + /** + * @description The SHA of the commit to which the analysis you are uploading relates. + * @pattern ^[0-9a-fA-F]+$ + */ "code-scanning-analysis-commit-sha": 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; @@ -6167,13 +6433,13 @@ export interface components { /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ "code-scanning-analysis-category": string; /** - * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "code-scanning-analysis-created-at": string; /** - * Format: uri * @description The REST API URL of the analysis resource. + * @format uri */ "code-scanning-analysis-url": string; "code-scanning-analysis-tool": { @@ -6181,10 +6447,14 @@ export interface components { version?: components["schemas"]["code-scanning-analysis-tool-version"]; guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** @description The version of the tool used to generate the code scanning analysis. */ + /** + * @nullable + * @description The version of the tool used to generate the code scanning analysis. + */ "code-scanning-analysis-tool-version": string | null; /** * Collaborator + * @nullable * @description Collaborator */ "nullable-collaborator": { @@ -6192,30 +6462,35 @@ export interface components { login: string; /** @example 1 */ id: number; + /** @nullable */ email?: string | null; + /** @nullable */ name?: string | null; /** @example MDQ6VXNlcjE= */ node_id: string; /** - * Format: uri * @example https://github.com/images/error/octocat_happy.gif + * @format uri */ avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ + /** + * @nullable + * @example 41d064eb2195891e12d0413f63227ea7 + */ gravatar_id: string | null; /** - * Format: uri * @example https://api.github.com/users/octocat + * @format uri */ url: string; /** - * Format: uri * @example https://github.com/octocat + * @format uri */ html_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/followers + * @format uri */ followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ @@ -6225,25 +6500,25 @@ export interface components { /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ starred_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/subscriptions + * @format uri */ subscriptions_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/orgs + * @format uri */ organizations_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/repos + * @format uri */ repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ events_url: string; /** - * Format: uri * @example https://api.github.com/users/octocat/received_events + * @format uri */ received_events_url: string; /** @example User */ @@ -6261,6 +6536,7 @@ export interface components { } | null; /** * Repository + * @nullable * @description A git repository */ "nullable-repository": { @@ -6295,16 +6571,19 @@ export interface components { */ private: boolean; /** - * Format: uri * @example https://github.com/octocat/Hello-World + * @format uri */ html_url: string; - /** @example This your first repo! */ + /** + * @nullable + * @example This your first repo! + */ description: string | null; fork: boolean; /** - * Format: uri * @example https://api.github.com/repos/octocat/Hello-World + * @format uri */ url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ @@ -6326,28 +6605,28 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ contents_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors + * @format uri */ contributors_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @format uri */ deployments_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @format uri */ downloads_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events + * @format uri */ events_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks + * @format uri */ forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ @@ -6369,13 +6648,13 @@ export interface components { /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ labels_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages + * @format uri */ languages_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges + * @format uri */ merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ @@ -6389,30 +6668,30 @@ export interface components { /** @example git@github.com:octocat/Hello-World.git */ ssh_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @format uri */ stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ statuses_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @format uri */ subscribers_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @format uri */ subscription_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags + * @format uri */ tags_url: string; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams + * @format uri */ teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ @@ -6420,25 +6699,28 @@ export interface components { /** @example https://github.com/octocat/Hello-World.git */ clone_url: string; /** - * Format: uri + * @nullable * @example git:git.example.com/octocat/Hello-World + * @format uri */ mirror_url: string | null; /** - * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks + * @format uri */ hooks_url: string; /** - * Format: uri * @example https://svn.github.com/octocat/Hello-World + * @format uri */ svn_url: string; /** - * Format: uri + * @nullable * @example https://github.com + * @format uri */ homepage: string | null; + /** @nullable */ language: string | null; /** @example 9 */ forks_count: number; @@ -6503,18 +6785,21 @@ export interface components { */ visibility: string; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:06:43Z + * @format date-time */ pushed_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:01:12Z + * @format date-time */ created_at: string | null; /** - * Format: date-time + * @nullable * @example 2011-01-26T19:14:43Z + * @format date-time */ updated_at: string | null; /** @@ -6523,6 +6808,7 @@ export interface components { * @example true */ allow_rebase_merge: boolean; + /** @nullable */ template_repository?: { id?: number; node_id?: string; @@ -6761,8 +7047,8 @@ export interface components { */ "code-of-conduct-simple": { /** - * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @format uri */ url: string; /** @example citizen_code_of_conduct */ @@ -6770,11 +7056,13 @@ export interface components { /** @example Citizen Code of Conduct */ name: string; /** - * Format: uri + * @nullable * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @format uri */ html_url: string | null; }; + /** @nullable */ "security-and-analysis": { advanced_security?: { /** @enum {string} */ @@ -6794,10 +7082,14 @@ export interface components { * @description Scim Error */ "scim-error": { + /** @nullable */ message?: string | null; + /** @nullable */ documentation_url?: string | null; + /** @nullable */ detail?: string | null; status?: number; + /** @nullable */ scimType?: string | null; schemas?: string[]; }; @@ -6806,9 +7098,9 @@ export interface components { * @description Data related to a release. */ "release-asset": { - /** Format: uri */ + /** @format uri */ url: string; - /** Format: uri */ + /** @format uri */ browser_download_url: string; id: number; node_id: string; @@ -6817,6 +7109,7 @@ export interface components { * @example Team Environment */ name: string; + /** @nullable */ label: string | null; /** * @description State of the release asset. @@ -6826,15 +7119,15 @@ export interface components { content_type: string; size: number; download_count: number; - /** Format: date-time */ + /** @format date-time */ created_at: string; - /** Format: date-time */ + /** @format date-time */ updated_at: string; uploader: components["schemas"]["nullable-simple-user"]; }; /** Reaction Rollup */ "reaction-rollup": { - /** Format: uri */ + /** @format uri */ url: string; total_count: number; "+1": number; @@ -6847,8 +7140,8 @@ export interface components { rocket: number; }; /** - * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @format date-time */ "alert-updated-at": string; /** @@ -6861,8 +7154,8 @@ export interface components { /** @example Contributor Covenant */ name: string; /** - * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant + * @format uri */ url: string; /** @@ -6916,7 +7209,10 @@ export interface components { * [version]: http://contributor-covenant.org/version/1/4/ */ body?: string; - /** Format: uri */ + /** + * @nullable + * @format uri + */ html_url: string | null; }; }; @@ -8494,6 +8790,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description A list of scopes that this authorization is in. * @example [ * "public_repo", @@ -8552,6 +8849,7 @@ export interface operations { /** @description The OAuth app client secret for which to create the token. */ client_secret: string; /** + * @nullable * @description A list of scopes that this authorization is in. * @example [ * "public_repo", @@ -8617,6 +8915,7 @@ export interface operations { /** @description The OAuth app client secret for which to create the token. */ client_secret: string; /** + * @nullable * @description A list of scopes that this authorization is in. * @example [ * "public_repo", @@ -8724,6 +9023,7 @@ export interface operations { content: { "application/json": { /** + * @nullable * @description A list of scopes that this authorization is in. * @example [ * "public_repo", @@ -11000,7 +11300,7 @@ export interface operations { git: { /** @enum {string} */ sync_status: "offline" | "inactive" | "in_sync" | "not_in_sync"; - /** Format: date-time */ + /** @format date-time */ last_sync: string; }; }[]; diff --git a/packages/openapi-typescript/examples/simple-example.ts b/packages/openapi-typescript/examples/simple-example.ts index e98bfea5f..a5a8b1235 100644 --- a/packages/openapi-typescript/examples/simple-example.ts +++ b/packages/openapi-typescript/examples/simple-example.ts @@ -163,8 +163,8 @@ export interface components { */ Problem: { /** - * Format: uri * @description A URI reference [RFC3986] that identifies the problem type. + * @format uri */ type: string; /** @description A short, human-readable summary of the problem type. */ @@ -177,7 +177,7 @@ export interface components { detail: string; }; Pet: { - /** Format: int64 */ + /** @format int64 */ id: number; name: string; none?: null; diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index 934a34ee5..b84fcdabd 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -8856,9 +8856,13 @@ export interface components { * to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). */ account: { - /** @description Business information about the account. */ + /** + * @nullable + * @description Business information about the account. + */ business_profile?: components["schemas"]["account_business_profile"] | null; /** + * @nullable * @description The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. * @enum {string|null} */ @@ -8871,15 +8875,18 @@ export interface components { /** @description The account's country. */ country?: string; /** - * Format: unix-time * @description Time at which the account was connected. Measured in seconds since the Unix epoch. + * @format unix-time */ created?: number; /** @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). */ default_currency?: string; /** @description Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details. */ details_submitted?: boolean; - /** @description An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. */ + /** + * @nullable + * @description An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. + */ email?: string | null; /** * ExternalAccountList @@ -8899,7 +8906,10 @@ export interface components { url: string; }; future_requirements?: components["schemas"]["account_future_requirements"]; - /** @description The groups associated with the account. */ + /** + * @nullable + * @description The groups associated with the account. + */ groups?: components["schemas"]["account_group_membership"] | null; /** @description Unique identifier for the object. */ id: string; @@ -8916,7 +8926,10 @@ export interface components { /** @description Whether the funds in this account can be paid out. */ payouts_enabled?: boolean; requirements?: components["schemas"]["account_requirements"]; - /** @description Options for customizing how the account functions within Stripe. */ + /** + * @nullable + * @description Options for customizing how the account functions within Stripe. + */ settings?: components["schemas"]["account_settings"] | null; tos_acceptance?: components["schemas"]["account_tos_acceptance"]; /** @@ -8927,56 +8940,111 @@ export interface components { }; /** AccountAnnualRevenue */ account_annual_revenue: { - /** @description A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). */ + /** + * @nullable + * @description A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). + */ amount?: number | null; /** - * Format: currency + * @nullable * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string | null; - /** @description The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. */ + /** + * @nullable + * @description The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. + */ fiscal_year_end?: string | null; }; /** AccountBacsDebitPaymentsSettings */ account_bacs_debit_payments_settings: { - /** @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. + */ icon?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. + */ logo?: (string | components["schemas"]["file"]) | null; - /** @description A CSS hex color value representing the primary branding color for this account */ + /** + * @nullable + * @description A CSS hex color value representing the primary branding color for this account + */ primary_color?: string | null; - /** @description A CSS hex color value representing the secondary branding color for this account */ + /** + * @nullable + * @description A CSS hex color value representing the secondary branding color for this account + */ secondary_color?: string | null; }; /** AccountBusinessProfile */ account_business_profile: { - /** @description The applicant's gross annual revenue for its preceding fiscal year. */ + /** + * @nullable + * @description The applicant's gross annual revenue for its preceding fiscal year. + */ annual_revenue?: components["schemas"]["account_annual_revenue"] | null; - /** @description An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. */ + /** + * @nullable + * @description An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. + */ estimated_worker_count?: number | null; - /** @description [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ + /** + * @nullable + * @description [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. + */ mcc?: string | null; monthly_estimated_revenue?: components["schemas"]["account_monthly_estimated_revenue"]; - /** @description The customer-facing business name. */ + /** + * @nullable + * @description The customer-facing business name. + */ name?: string | null; - /** @description Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. */ + /** + * @nullable + * @description Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. + */ product_description?: string | null; - /** @description A publicly available mailing address for sending support issues to. */ + /** + * @nullable + * @description A publicly available mailing address for sending support issues to. + */ support_address?: components["schemas"]["address"] | null; - /** @description A publicly available email address for sending support issues to. */ + /** + * @nullable + * @description A publicly available email address for sending support issues to. + */ support_email?: string | null; - /** @description A publicly available phone number to call with support issues. */ + /** + * @nullable + * @description A publicly available phone number to call with support issues. + */ support_phone?: string | null; - /** @description A publicly available website for handling support issues. */ + /** + * @nullable + * @description A publicly available website for handling support issues. + */ support_url?: string | null; - /** @description The business's publicly available website. */ + /** + * @nullable + * @description The business's publicly available website. + */ url?: string | null; }; /** AccountCapabilities */ @@ -9254,16 +9322,21 @@ export interface components { }; /** AccountCapabilityFutureRequirements */ account_capability_future_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** - * Format: unix-time + * @nullable * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning. + * @format unix-time */ current_deadline?: number | null; /** @description Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ currently_due: string[]; /** + * @nullable * @description This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account. * @enum {string|null} */ @@ -9279,16 +9352,21 @@ export interface components { }; /** AccountCapabilityRequirements */ account_capability_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** - * Format: unix-time + * @nullable * @description Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected. + * @format unix-time */ current_deadline?: number | null; /** @description Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. */ currently_due: string[]; /** + * @nullable * @description Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). * @enum {string|null} */ @@ -9309,18 +9387,33 @@ export interface components { /** AccountCardPaymentsSettings */ account_card_payments_settings: { decline_on?: components["schemas"]["account_decline_charge_on"]; - /** @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. */ + /** + * @nullable + * @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. + */ statement_descriptor_prefix?: string | null; - /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. */ + /** + * @nullable + * @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. + */ statement_descriptor_prefix_kana?: string | null; - /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. */ + /** + * @nullable + * @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. + */ statement_descriptor_prefix_kanji?: string | null; }; /** AccountDashboardSettings */ account_dashboard_settings: { - /** @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ + /** + * @nullable + * @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. + */ display_name?: string | null; - /** @description The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). */ + /** + * @nullable + * @description The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). + */ timezone?: string | null; }; /** AccountDeclineChargeOn */ @@ -9332,37 +9425,63 @@ export interface components { }; /** AccountFutureRequirements */ account_future_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** - * Format: unix-time + * @nullable * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. + * @format unix-time */ 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. */ + /** + * @nullable + * @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; /** + * @nullable * @description This is typed as an enum for consistency with `requirements.disabled_reason`. * @enum {string|null} */ disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** + * @nullable + * @description Fields that are `currently_due` and need to be collected again because validation or verification failed. + */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ + /** + * @nullable + * @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. + */ eventually_due?: string[] | null; - /** @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ + /** + * @nullable + * @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. + */ past_due?: string[] | null; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** + * @nullable + * @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. + */ pending_verification?: string[] | null; }; /** AccountGroupMembership */ account_group_membership: { - /** @description The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. */ + /** + * @nullable + * @description The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. + */ payments_pricing?: string | null; }; /** AccountInvoicesSettings */ account_invoices_settings: { - /** @description The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. */ + /** + * @nullable + * @description The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. + */ default_account_tax_ids?: (string | components["schemas"]["tax_id"])[] | null; }; /** @@ -9374,13 +9493,13 @@ export interface components { */ account_link: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time * @description The timestamp at which this account link will expire. + * @format unix-time */ expires_at: number; /** @@ -9396,22 +9515,37 @@ export interface components { /** @description A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; }; /** AccountPaymentsSettings */ account_payments_settings: { - /** @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. */ + /** + * @nullable + * @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. + */ statement_descriptor?: string | null; - /** @description The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /** + * @nullable + * @description The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + */ statement_descriptor_kana?: string | null; - /** @description The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /** + * @nullable + * @description The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + */ statement_descriptor_kanji?: string | null; - /** @description The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /** + * @nullable + * @description The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + */ statement_descriptor_prefix_kana?: string | null; - /** @description The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /** + * @nullable + * @description The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). + */ statement_descriptor_prefix_kanji?: string | null; }; /** AccountPayoutSettings */ @@ -9419,32 +9553,55 @@ export interface components { /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`. */ debit_negative_balances: boolean; schedule: components["schemas"]["transfer_schedule"]; - /** @description The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. */ + /** + * @nullable + * @description The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. + */ statement_descriptor?: string | null; }; /** AccountRequirements */ account_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** - * Format: unix-time + * @nullable * @description Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. + * @format unix-time */ 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. */ + /** + * @nullable + * @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; /** + * @nullable * @description If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). * @enum {string|null} */ disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** + * @nullable + * @description Fields that are `currently_due` and need to be collected again because validation or verification failed. + */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ + /** + * @nullable + * @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. + */ eventually_due?: string[] | null; - /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ + /** + * @nullable + * @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. + */ past_due?: string[] | null; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** + * @nullable + * @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. + */ pending_verification?: string[] | null; }; /** AccountRequirementsAlternative */ @@ -9494,8 +9651,8 @@ export interface components { client_secret: string; components: components["schemas"]["connect_embedded_account_session_create_components"]; /** - * Format: unix-time * @description The timestamp at which this AccountSession will expire. + * @format unix-time */ expires_at: number; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -9521,9 +9678,15 @@ export interface components { }; /** AccountTermsOfService */ account_terms_of_service: { - /** @description The Unix timestamp marking when the account representative accepted the service agreement. */ + /** + * @nullable + * @description The Unix timestamp marking when the account representative accepted the service agreement. + */ date?: number | null; - /** @description The IP address from which the account representative accepted the service agreement. */ + /** + * @nullable + * @description The IP address from which the account representative accepted the service agreement. + */ ip?: string | null; /** @description The user agent of the browser from which the account representative accepted the service agreement. */ user_agent?: string; @@ -9531,15 +9694,22 @@ export interface components { /** AccountTOSAcceptance */ account_tos_acceptance: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the account representative accepted their service agreement + * @format unix-time */ date?: number | null; - /** @description The IP address from which the account representative accepted their service agreement */ + /** + * @nullable + * @description The IP address from which the account representative accepted their service agreement + */ ip?: string | null; /** @description The user's service agreement type */ service_agreement?: string; - /** @description The user agent of the browser from which the account representative accepted their service agreement */ + /** + * @nullable + * @description The user agent of the browser from which the account representative accepted their service agreement + */ user_agent?: string | null; }; /** AccountTreasurySettings */ @@ -9590,23 +9760,42 @@ export interface components { }; /** Address */ address: { - /** @description City, district, suburb, town, or village. */ + /** + * @nullable + * @description City, district, suburb, town, or village. + */ city?: string | null; - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; - /** @description Address line 1 (e.g., street, PO Box, or company name). */ + /** + * @nullable + * @description Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string | null; - /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + /** + * @nullable + * @description Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ postal_code?: string | null; - /** @description State, county, province, or region. */ + /** + * @nullable + * @description State, county, province, or region. + */ state?: string | null; }; /** amazon_pay_underlying_payment_method_funding_details */ amazon_pay_underlying_payment_method_funding_details: { card?: components["schemas"]["payment_method_details_passthrough_card"]; /** + * @nullable * @description funding type of the underlying payment method. * @enum {string|null} */ @@ -9650,8 +9839,8 @@ export interface components { /** ApplePayDomain */ apple_pay_domain: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; domain_name: string; @@ -9669,7 +9858,10 @@ export interface components { application: { /** @description Unique identifier for the object. */ id: string; - /** @description The name of the application. */ + /** + * @nullable + * @description The name of the application. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -9687,21 +9879,27 @@ export interface components { amount_refunded: number; /** @description ID of the Connect application that earned the fee. */ application: string | components["schemas"]["application"]; - /** @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ + /** + * @nullable + * @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** @description ID of the charge that the application fee was taken from. */ charge: string | components["schemas"]["charge"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description Polymorphic source of the application fee. Includes the ID of the object the application fee was created from. */ + /** + * @nullable + * @description Polymorphic source of the application fee. Includes the ID of the object the application fee was created from. + */ fee_source?: components["schemas"]["platform_earning_fee_source"] | null; /** @description Unique identifier for the object. */ id: string; @@ -9712,7 +9910,10 @@ export interface components { * @enum {string} */ object: "application_fee"; - /** @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ + /** + * @nullable + * @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. + */ originating_transaction?: (string | components["schemas"]["charge"]) | null; /** @description Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ refunded: boolean; @@ -9748,15 +9949,16 @@ export interface components { */ "apps.secret": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description If true, indicates that this secret has been deleted */ deleted?: boolean; /** - * Format: unix-time + * @nullable * @description The Unix timestamp for the expiry time of the secret, after which the secret deletes. + * @format unix-time */ expires_at?: number | null; /** @description Unique identifier for the object. */ @@ -9770,22 +9972,30 @@ export interface components { * @enum {string} */ object: "apps.secret"; - /** @description The plaintext secret value to be stored. */ + /** + * @nullable + * @description The plaintext secret value to be stored. + */ payload?: string | null; scope: components["schemas"]["secret_service_resource_scope"]; }; /** AutomaticTax */ automatic_tax: { /** + * @nullable * @description If Stripe disabled automatic tax, this enum describes why. * @enum {string|null} */ disabled_reason?: "finalization_requires_location_inputs" | "finalization_system_error" | null; /** @description Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; /** + * @nullable * @description The status of the most recent automated tax calculation for this invoice. * @enum {string|null} */ @@ -9828,8 +10038,8 @@ export interface components { /** @description Balance amount. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; source_types?: components["schemas"]["balance_amount_by_source_type"]; @@ -9848,8 +10058,8 @@ export interface components { /** @description Balance amount. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Breakdown of balance by destination. */ @@ -9880,23 +10090,29 @@ export interface components { /** @description Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. */ amount: number; /** - * Format: unix-time * @description The date that the transaction's net funds become available in the Stripe balance. + * @format unix-time */ available_on: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. */ + /** + * @nullable + * @description If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. + */ exchange_rate?: number | null; /** @description Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. */ fee: number; @@ -9913,7 +10129,10 @@ export interface components { object: "balance_transaction"; /** @description Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. */ reporting_category: string; - /** @description This transaction relates to the Stripe object. */ + /** + * @nullable + * @description This transaction relates to the Stripe object. + */ source?: (string | components["schemas"]["application_fee"] | components["schemas"]["charge"] | components["schemas"]["connect_collection_transfer"] | components["schemas"]["customer_cash_balance_transaction"] | components["schemas"]["dispute"] | components["schemas"]["fee_refund"] | components["schemas"]["issuing.authorization"] | components["schemas"]["issuing.dispute"] | components["schemas"]["issuing.transaction"] | components["schemas"]["payout"] | components["schemas"]["refund"] | components["schemas"]["reserve_transaction"] | components["schemas"]["tax_deducted_at_source"] | components["schemas"]["topup"] | components["schemas"]["transfer"] | components["schemas"]["transfer_reversal"]) | null; /** @description The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. */ status: string; @@ -9934,38 +10153,71 @@ export interface components { * Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) */ bank_account: { - /** @description The ID of the account that the bank account is associated with. */ + /** + * @nullable + * @description The ID of the account that the bank account is associated with. + */ account?: (string | components["schemas"]["account"]) | null; - /** @description The name of the person or business that owns the bank account. */ + /** + * @nullable + * @description The name of the person or business that owns the bank account. + */ account_holder_name?: string | null; - /** @description The type of entity that holds the account. This can be either `individual` or `company`. */ + /** + * @nullable + * @description The type of entity that holds the account. This can be either `individual` or `company`. + */ account_holder_type?: string | null; - /** @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. */ + /** + * @nullable + * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. + */ account_type?: string | null; - /** @description A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. */ + /** + * @nullable + * @description A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. + */ available_payout_methods?: ("instant" | "standard")[] | null; - /** @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ + /** + * @nullable + * @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). + */ bank_name?: string | null; /** @description Two-letter ISO code representing the country the bank account is located in. */ country: string; /** - * Format: currency * @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. + * @format currency */ currency: string; - /** @description The ID of the customer that the bank account is associated with. */ + /** + * @nullable + * @description The ID of the customer that the bank account is associated with. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description Whether this bank account is the default external account for its currency. */ + /** + * @nullable + * @description Whether this bank account is the default external account for its currency. + */ default_for_currency?: boolean | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. */ + /** + * @nullable + * @description Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. + */ future_requirements?: components["schemas"]["external_account_requirements"] | null; /** @description Unique identifier for the object. */ id: string; /** @description The last four digits of the bank account number. */ last4: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -9974,9 +10226,15 @@ export interface components { * @enum {string} */ object: "bank_account"; - /** @description Information about the requirements for the bank account, including what information needs to be collected. */ + /** + * @nullable + * @description Information about the requirements for the bank account, including what information needs to be collected. + */ requirements?: components["schemas"]["external_account_requirements"] | null; - /** @description The routing transit number for the bank account. */ + /** + * @nullable + * @description The routing transit number for the bank account. + */ routing_number?: string | null; /** * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. @@ -10000,8 +10258,8 @@ export interface components { /** BankConnectionsResourceBalance */ bank_connections_resource_balance: { /** - * Format: unix-time * @description The time that the external institution calculated this balance. Measured in seconds since the Unix epoch. + * @format unix-time */ as_of: number; cash?: components["schemas"]["bank_connections_resource_balance_api_resource_cash_balance"]; @@ -10025,6 +10283,7 @@ export interface components { /** BankConnectionsResourceBalanceAPIResourceCashBalance */ bank_connections_resource_balance_api_resource_cash_balance: { /** + * @nullable * @description The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions. * * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. @@ -10038,6 +10297,7 @@ export interface components { /** BankConnectionsResourceBalanceAPIResourceCreditBalance */ bank_connections_resource_balance_api_resource_credit_balance: { /** + * @nullable * @description The credit that has been used by the account holder. * * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. @@ -10051,13 +10311,14 @@ export interface components { /** BankConnectionsResourceBalanceRefresh */ bank_connections_resource_balance_refresh: { /** - * Format: unix-time * @description The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. + * @format unix-time */ last_attempted_at: number; /** - * Format: unix-time + * @nullable * @description Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. + * @format unix-time */ next_refresh_available_at?: number | null; /** @@ -10068,21 +10329,28 @@ export interface components { }; /** BankConnectionsResourceLinkAccountSessionFilters */ bank_connections_resource_link_account_session_filters: { - /** @description Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`. */ + /** + * @nullable + * @description Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`. + */ account_subcategories?: ("checking" | "credit_card" | "line_of_credit" | "mortgage" | "savings")[] | null; - /** @description List of countries from which to filter accounts. */ + /** + * @nullable + * @description List of countries from which to filter accounts. + */ countries?: string[] | null; }; /** BankConnectionsResourceOwnershipRefresh */ bank_connections_resource_ownership_refresh: { /** - * Format: unix-time * @description The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. + * @format unix-time */ last_attempted_at: number; /** - * Format: unix-time + * @nullable * @description Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. + * @format unix-time */ next_refresh_available_at?: number | null; /** @@ -10096,13 +10364,14 @@ export interface components { /** @description Unique identifier for the object. */ id: string; /** - * Format: unix-time * @description The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. + * @format unix-time */ last_attempted_at: number; /** - * Format: unix-time + * @nullable * @description Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. + * @format unix-time */ next_refresh_available_at?: number | null; /** @@ -10114,13 +10383,15 @@ export interface components { /** BankConnectionsResourceTransactionResourceStatusTransitions */ bank_connections_resource_transaction_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Time at which this transaction posted. Measured in seconds since the Unix epoch. + * @format unix-time */ posted_at?: number | null; /** - * Format: unix-time + * @nullable * @description Time at which this transaction was voided. Measured in seconds since the Unix epoch. + * @format unix-time */ void_at?: number | null; }; @@ -10144,13 +10415,17 @@ export interface components { */ object: "billing.alert"; /** + * @nullable * @description Status of the alert. This can be active, inactive or archived. * @enum {string|null} */ status?: "active" | "archived" | "inactive" | null; /** @description Title of the alert. */ title: string; - /** @description Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter). */ + /** + * @nullable + * @description Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter). + */ usage_threshold?: components["schemas"]["thresholds_resource_usage_threshold_config"] | null; }; /** @@ -10176,19 +10451,25 @@ export interface components { */ "billing.credit_balance_transaction": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description Credit details for this credit balance transaction. Only present if type is `credit`. */ + /** + * @nullable + * @description Credit details for this credit balance transaction. Only present if type is `credit`. + */ credit?: components["schemas"]["billing_credit_grants_resource_balance_credit"] | null; /** @description The credit grant associated with this credit balance transaction. */ credit_grant: string | components["schemas"]["billing.credit_grant"]; - /** @description Debit details for this credit balance transaction. Only present if type is `debit`. */ + /** + * @nullable + * @description Debit details for this credit balance transaction. Only present if type is `debit`. + */ debit?: components["schemas"]["billing_credit_grants_resource_balance_debit"] | null; /** - * Format: unix-time * @description The effective time of this credit balance transaction. + * @format unix-time */ effective_at: number; /** @description Unique identifier for the object. */ @@ -10200,9 +10481,13 @@ export interface components { * @enum {string} */ object: "billing.credit_balance_transaction"; - /** @description ID of the test clock this credit balance transaction belongs to. */ + /** + * @nullable + * @description ID of the test clock this credit balance transaction belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; /** + * @nullable * @description The type of credit balance transaction (credit or debit). * @enum {string|null} */ @@ -10223,20 +10508,22 @@ export interface components { */ category: "paid" | "promotional"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description ID of the customer receiving the billing credits. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; /** - * Format: unix-time + * @nullable * @description The time when the billing credits become effective-when they're eligible for use. + * @format unix-time */ effective_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time when the billing credits expire. If not present, the billing credits don't expire. + * @format unix-time */ expires_at?: number | null; /** @description Unique identifier for the object. */ @@ -10247,23 +10534,30 @@ export interface components { metadata: { [key: string]: string; }; - /** @description A descriptive name shown in dashboard. */ + /** + * @nullable + * @description A descriptive name shown in dashboard. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "billing.credit_grant"; - /** @description ID of the test clock this credit grant belongs to. */ + /** + * @nullable + * @description ID of the test clock this credit grant belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; /** - * Format: unix-time + * @nullable * @description The time when this credit grant was voided. If not present, the credit grant hasn't been voided. + * @format unix-time */ voided_at?: number | null; }; @@ -10275,8 +10569,8 @@ export interface components { */ "billing.meter": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; customer_mapping: components["schemas"]["billing_meter_resource_customer_mapping_settings"]; @@ -10286,6 +10580,7 @@ export interface components { /** @description The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. */ event_name: string; /** + * @nullable * @description The time window to pre-aggregate meter events for, if any. * @enum {string|null} */ @@ -10306,8 +10601,8 @@ export interface components { status: "active" | "inactive"; status_transitions: components["schemas"]["billing_meter_resource_billing_meter_status_transitions"]; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; value_settings: components["schemas"]["billing_meter_resource_billing_meter_value"]; @@ -10318,8 +10613,8 @@ export interface components { */ "billing.meter_event": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The name of the meter event. Corresponds with the `event_name` field on a meter. */ @@ -10338,8 +10633,8 @@ export interface components { [key: string]: string; }; /** - * Format: unix-time * @description The timestamp passed in when creating the event. Measured in seconds since the Unix epoch. + * @format unix-time */ timestamp: number; }; @@ -10348,7 +10643,10 @@ export interface components { * @description A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer. */ "billing.meter_event_adjustment": { - /** @description Specifies which event to cancel. */ + /** + * @nullable + * @description Specifies which event to cancel. + */ cancel?: components["schemas"]["billing_meter_resource_billing_meter_event_adjustment_cancel"] | null; /** @description The name of the meter event. Corresponds with the `event_name` field on a meter. */ event_name: string; @@ -10379,8 +10677,8 @@ export interface components { /** @description Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`. */ aggregated_value: number; /** - * Format: unix-time * @description End timestamp for this event summary (exclusive). Must be aligned with minute boundaries. + * @format unix-time */ end_time: number; /** @description Unique identifier for the object. */ @@ -10395,16 +10693,16 @@ export interface components { */ object: "billing.meter_event_summary"; /** - * Format: unix-time * @description Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries. + * @format unix-time */ start_time: number; }; /** BillingClocksResourceStatusDetailsAdvancingStatusDetails */ billing_clocks_resource_status_details_advancing_status_details: { /** - * Format: unix-time * @description The `frozen_time` that the Test Clock is advancing towards. + * @format unix-time */ target_frozen_time: number; }; @@ -10414,7 +10712,10 @@ export interface components { }; /** BillingCreditGrantsResourceAmount */ billing_credit_grants_resource_amount: { - /** @description The monetary amount. */ + /** + * @nullable + * @description The monetary amount. + */ monetary?: components["schemas"]["billing_credit_grants_resource_monetary_amount"] | null; /** * @description The type of this amount. We currently only support `monetary` billing credits. @@ -10429,7 +10730,10 @@ export interface components { /** BillingCreditGrantsResourceBalanceCredit */ billing_credit_grants_resource_balance_credit: { amount: components["schemas"]["billing_credit_grants_resource_amount"]; - /** @description Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`. */ + /** + * @nullable + * @description Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`. + */ credits_application_invoice_voided?: components["schemas"]["billing_credit_grants_resource_balance_credits_application_invoice_voided"] | null; /** * @description The type of credit transaction. @@ -10454,7 +10758,10 @@ export interface components { /** BillingCreditGrantsResourceBalanceDebit */ billing_credit_grants_resource_balance_debit: { amount: components["schemas"]["billing_credit_grants_resource_amount"]; - /** @description Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`. */ + /** + * @nullable + * @description Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`. + */ credits_applied?: components["schemas"]["billing_credit_grants_resource_balance_credits_applied"] | null; /** * @description The type of debit transaction. @@ -10479,13 +10786,25 @@ export interface components { }; /** billing_details */ billing_details: { - /** @description Billing address. */ + /** + * @nullable + * @description Billing address. + */ address?: components["schemas"]["address"] | null; - /** @description Email address. */ + /** + * @nullable + * @description Email address. + */ email?: string | null; - /** @description Full name. */ + /** + * @nullable + * @description Full name. + */ name?: string | null; - /** @description Billing phone number (including extension). */ + /** + * @nullable + * @description Billing phone number (including extension). + */ phone?: string | null; }; /** BillingMeterResourceAggregationSettings */ @@ -10498,14 +10817,18 @@ export interface components { }; /** BillingMeterResourceBillingMeterEventAdjustmentCancel */ billing_meter_resource_billing_meter_event_adjustment_cancel: { - /** @description Unique identifier for the event. */ + /** + * @nullable + * @description Unique identifier for the event. + */ identifier?: string | null; }; /** BillingMeterResourceBillingMeterStatusTransitions */ billing_meter_resource_billing_meter_status_transitions: { /** - * Format: unix-time + * @nullable * @description The time the meter was deactivated, if any. Measured in seconds since Unix epoch. + * @format unix-time */ deactivated_at?: number | null; }; @@ -10531,15 +10854,21 @@ export interface components { "billing_portal.configuration": { /** @description Whether the configuration is active and can be used to create portal sessions. */ active: boolean; - /** @description ID of the Connect Application that created the configuration. */ + /** + * @nullable + * @description ID of the Connect Application that created the configuration. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; business_profile: components["schemas"]["portal_business_profile"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ + /** + * @nullable + * @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. + */ default_return_url?: string | null; features: components["schemas"]["portal_features"]; /** @description Unique identifier for the object. */ @@ -10549,7 +10878,10 @@ export interface components { /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; login_page: components["schemas"]["portal_login_page"]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -10559,8 +10891,8 @@ export interface components { */ object: "billing_portal.configuration"; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; }; @@ -10585,19 +10917,23 @@ export interface components { /** @description The configuration used by this session, describing the features available. */ configuration: string | components["schemas"]["billing_portal.configuration"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The ID of the customer for this session. */ customer: string; - /** @description Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. */ + /** + * @nullable + * @description Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. + */ flow?: components["schemas"]["portal_flows_flow"] | 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; /** + * @nullable * @description The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. * @enum {string|null} */ @@ -10607,23 +10943,34 @@ export interface components { * @enum {string} */ object: "billing_portal.session"; - /** @description The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ + /** + * @nullable + * @description The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. + */ on_behalf_of?: string | null; - /** @description The URL to redirect customers to when they click on the portal's link to return to your website. */ + /** + * @nullable + * @description The URL to redirect customers to when they click on the portal's link to return to your website. + */ return_url?: string | null; /** @description The short-lived URL of the session that gives customers access to the customer portal. */ url: string; }; /** CancellationDetails */ cancellation_details: { - /** @description Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. */ + /** + * @nullable + * @description Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. + */ comment?: string | null; /** + * @nullable * @description The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. * @enum {string|null} */ feedback?: "customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused" | null; /** + * @nullable * @description Why this subscription was canceled. * @enum {string|null} */ @@ -10649,8 +10996,9 @@ export interface components { /** @description Whether the capability has been requested. */ requested: boolean; /** - * Format: unix-time + * @nullable * @description Time at which the capability was requested. Measured in seconds since the Unix epoch. + * @format unix-time */ requested_at?: number | null; requirements?: components["schemas"]["account_capability_requirements"]; @@ -10669,53 +11017,101 @@ export interface components { * Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards) */ card: { - /** @description The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /** + * @nullable + * @description The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + */ account?: (string | components["schemas"]["account"]) | null; - /** @description City/District/Suburb/Town/Village. */ + /** + * @nullable + * @description City/District/Suburb/Town/Village. + */ address_city?: string | null; - /** @description Billing address country, if provided when creating card. */ + /** + * @nullable + * @description Billing address country, if provided when creating card. + */ address_country?: string | null; - /** @description Address line 1 (Street address/PO Box/Company name). */ + /** + * @nullable + * @description Address line 1 (Street address/PO Box/Company name). + */ address_line1?: string | null; - /** @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ + /** + * @nullable + * @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. + */ address_line1_check?: string | null; - /** @description Address line 2 (Apartment/Suite/Unit/Building). */ + /** + * @nullable + * @description Address line 2 (Apartment/Suite/Unit/Building). + */ address_line2?: string | null; - /** @description State/County/Province/Region. */ + /** + * @nullable + * @description State/County/Province/Region. + */ address_state?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ address_zip?: string | null; - /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ + /** + * @nullable + * @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. + */ address_zip_check?: string | null; /** + * @nullable * @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. * @enum {string|null} */ allow_redisplay?: "always" | "limited" | "unspecified" | null; - /** @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. */ + /** + * @nullable + * @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. + */ available_payout_methods?: ("instant" | "standard")[] | null; /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ brand: string; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; /** - * Format: currency + * @nullable * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + * @format currency */ currency?: string | null; - /** @description The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. */ + /** + * @nullable + * @description The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). */ + /** + * @nullable + * @description If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). + */ cvc_check?: string | null; - /** @description Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /** + * @nullable + * @description Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + */ default_for_currency?: boolean | null; - /** @description (For tokenized numbers only.) The last four digits of the device account number. */ + /** + * @nullable + * @description (For tokenized numbers only.) The last four digits of the device account number. + */ dynamic_last4?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* @@ -10729,11 +11125,17 @@ export interface components { iin?: string; /** @description The last four digits of the card. */ last4: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description Cardholder name. */ + /** + * @nullable + * @description Cardholder name. + */ name?: string | null; networks?: components["schemas"]["token_card_networks"]; /** @@ -10742,13 +11144,20 @@ export interface components { */ object: "card"; /** + * @nullable * @description Status of a card based on the card issuer. * @enum {string|null} */ regulated_status?: "regulated" | "unregulated" | null; - /** @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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; }; /** card_generated_from_payment_method_details */ @@ -10759,9 +11168,15 @@ export interface components { }; /** CardIssuingAccountTermsOfService */ card_issuing_account_terms_of_service: { - /** @description The Unix timestamp marking when the account representative accepted the service agreement. */ + /** + * @nullable + * @description The Unix timestamp marking when the account representative accepted the service agreement. + */ date?: number | null; - /** @description The IP address from which the account representative accepted the service agreement. */ + /** + * @nullable + * @description The IP address from which the account representative accepted the service agreement. + */ ip?: string | null; /** @description The user agent of the browser from which the account representative accepted the service agreement. */ user_agent?: string; @@ -10773,7 +11188,10 @@ export interface components { * @description A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. */ cash_balance: { - /** @description A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** + * @nullable + * @description A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + */ available?: { [key: string]: number; } | null; @@ -10802,46 +11220,82 @@ export interface components { amount_captured: number; /** @description Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ amount_refunded: number; - /** @description ID of the Connect application that created the charge. */ + /** + * @nullable + * @description ID of the Connect application that created the charge. + */ application?: (string | components["schemas"]["application"]) | null; - /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ + /** + * @nullable + * @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. + */ application_fee?: (string | components["schemas"]["application_fee"]) | null; - /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ + /** + * @nullable + * @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. + */ application_fee_amount?: number | null; - /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ + /** + * @nullable + * @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; billing_details: components["schemas"]["billing_details"]; - /** @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. */ + /** + * @nullable + * @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. + */ calculated_statement_descriptor?: string | null; /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ captured: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description ID of the customer this charge is for if one exists. */ + /** + * @nullable + * @description ID of the customer this charge is for if one exists. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description Whether the charge has been disputed. */ disputed: boolean; - /** @description ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. */ + /** + * @nullable + * @description ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. + */ failure_balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; - /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes). */ + /** + * @nullable + * @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes). + */ failure_code?: string | null; - /** @description Message to user further explaining reason for charge failure if available. */ + /** + * @nullable + * @description Message to user further explaining reason for charge failure if available. + */ failure_message?: string | null; - /** @description Information on fraud assessments for the charge. */ + /** + * @nullable + * @description Information on fraud assessments for the charge. + */ fraud_details?: components["schemas"]["charge_fraud_details"] | null; /** @description Unique identifier for the object. */ id: string; - /** @description ID of the invoice this charge is for if one exists. */ + /** + * @nullable + * @description ID of the invoice this charge is for if one exists. + */ invoice?: (string | components["schemas"]["invoice"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -10854,29 +11308,54 @@ export interface components { * @enum {string} */ object: "charge"; - /** @description The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ + /** + * @nullable + * @description The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. */ + /** + * @nullable + * @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. + */ outcome?: components["schemas"]["charge_outcome"] | null; /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ paid: boolean; - /** @description ID of the PaymentIntent associated with this charge, if one exists. */ + /** + * @nullable + * @description ID of the PaymentIntent associated with this charge, if one exists. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; - /** @description ID of the payment method used in this charge. */ + /** + * @nullable + * @description ID of the payment method used in this charge. + */ payment_method?: string | null; - /** @description Details about the payment method at the time of the transaction. */ + /** + * @nullable + * @description Details about the payment method at the time of the transaction. + */ payment_method_details?: components["schemas"]["payment_method_details"] | null; radar_options?: components["schemas"]["radar_radar_options"]; - /** @description This is the email address that the receipt for this charge was sent to. */ + /** + * @nullable + * @description This is the email address that the receipt for this charge was sent to. + */ receipt_email?: string | null; - /** @description This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent. */ + /** + * @nullable + * @description This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent. + */ receipt_number?: string | null; - /** @description This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt. */ + /** + * @nullable + * @description This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt. + */ receipt_url?: string | null; /** @description Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ refunded: boolean; /** * RefundList + * @nullable * @description A list of refunds that have been applied to the charge. */ refunds?: { @@ -10892,19 +11371,32 @@ export interface components { /** @description The URL where this list can be accessed. */ url: string; } | null; - /** @description ID of the review associated with this charge if one exists. */ + /** + * @nullable + * @description ID of the review associated with this charge if one exists. + */ review?: (string | components["schemas"]["review"]) | null; - /** @description Shipping information for the charge. */ + /** + * @nullable + * @description Shipping information for the charge. + */ shipping?: components["schemas"]["shipping"] | null; - /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. */ + /** + * @nullable + * @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. + */ source_transfer?: (string | components["schemas"]["transfer"]) | null; /** + * @nullable * @description For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). * * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. */ statement_descriptor?: string | null; - /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. */ + /** + * @nullable + * @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. + */ statement_descriptor_suffix?: string | null; /** * @description The status of the payment is either `succeeded`, `pending`, or `failed`. @@ -10913,9 +11405,15 @@ export interface components { status: "failed" | "pending" | "succeeded"; /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ transfer?: string | components["schemas"]["transfer"]; - /** @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ + /** + * @nullable + * @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. + */ transfer_data?: components["schemas"]["charge_transfer_data"] | null; - /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /** + * @nullable + * @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. + */ transfer_group?: string | null; }; /** ChargeFraudDetails */ @@ -10928,17 +11426,30 @@ export interface components { /** ChargeOutcome */ charge_outcome: { /** + * @nullable * @description An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines). * @enum {string|null} */ advice_code?: "confirm_card_data" | "do_not_try_again" | "try_again_later" | null; - /** @description For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. */ + /** + * @nullable + * @description For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. + */ network_advice_code?: string | null; - /** @description For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + /** + * @nullable + * @description For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. + */ network_decline_code?: string | null; - /** @description Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. */ + /** + * @nullable + * @description Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. + */ network_status?: string | null; - /** @description An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. */ + /** + * @nullable + * @description An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. + */ reason?: string | null; /** @description Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar. */ risk_level?: string; @@ -10946,14 +11457,20 @@ export interface components { risk_score?: number; /** @description The ID of the Radar rule that matched the payment, if applicable. */ rule?: string | components["schemas"]["rule"]; - /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ + /** + * @nullable + * @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. + */ seller_message?: string | null; /** @description Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details. */ type: string; }; /** ChargeTransferData */ charge_transfer_data: { - /** @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ + /** + * @nullable + * @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. + */ amount?: number | null; /** @description ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ destination: string | components["schemas"]["account"]; @@ -10976,52 +11493,86 @@ export interface components { * Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart) */ "checkout.session": { - /** @description Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). */ + /** + * @nullable + * @description Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). + */ adaptive_pricing?: components["schemas"]["payment_pages_checkout_session_adaptive_pricing"] | null; - /** @description When set, provides configuration for actions to take if this Checkout Session expires. */ + /** + * @nullable + * @description When set, provides configuration for actions to take if this Checkout Session expires. + */ after_expiration?: components["schemas"]["payment_pages_checkout_session_after_expiration"] | null; - /** @description Enables user redeemable promotion codes. */ + /** + * @nullable + * @description Enables user redeemable promotion codes. + */ allow_promotion_codes?: boolean | null; - /** @description Total of all items before discounts or taxes are applied. */ + /** + * @nullable + * @description Total of all items before discounts or taxes are applied. + */ amount_subtotal?: number | null; - /** @description Total of all items after discounts and taxes are applied. */ + /** + * @nullable + * @description Total of all items after discounts and taxes are applied. + */ amount_total?: number | null; automatic_tax: components["schemas"]["payment_pages_checkout_session_automatic_tax"]; /** + * @nullable * @description Describes whether Checkout should collect the customer's billing address. Defaults to `auto`. * @enum {string|null} */ billing_address_collection?: "auto" | "required" | null; - /** @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. */ + /** + * @nullable + * @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. + */ cancel_url?: string | null; /** + * @nullable * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * Session with your internal systems. */ client_reference_id?: string | null; - /** @description Client secret to be used when initializing Stripe.js embedded checkout. */ + /** + * @nullable + * @description Client secret to be used when initializing Stripe.js embedded checkout. + */ client_secret?: string | null; - /** @description Results of `consent_collection` for this session. */ + /** + * @nullable + * @description Results of `consent_collection` for this session. + */ consent?: components["schemas"]["payment_pages_checkout_session_consent"] | null; - /** @description When set, provides configuration for the Checkout Session to gather active consent from customers. */ + /** + * @nullable + * @description When set, provides configuration for the Checkout Session to gather active consent from customers. + */ consent_collection?: components["schemas"]["payment_pages_checkout_session_consent_collection"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency + * @nullable * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string | null; - /** @description Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions */ + /** + * @nullable + * @description Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions + */ currency_conversion?: components["schemas"]["payment_pages_checkout_session_currency_conversion"] | null; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields: components["schemas"]["payment_pages_checkout_session_custom_fields"][]; custom_text: components["schemas"]["payment_pages_checkout_session_custom_text"]; /** + * @nullable * @description The ID of the customer for this Session. * For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout * will create a new customer object based on information provided @@ -11030,13 +11581,18 @@ export interface components { */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** + * @nullable * @description Configure whether a Checkout Session creates a Customer when the Checkout Session completes. * @enum {string|null} */ customer_creation?: "always" | "if_required" | null; - /** @description The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode. */ + /** + * @nullable + * @description The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode. + */ customer_details?: components["schemas"]["payment_pages_checkout_session_customer_details"] | null; /** + * @nullable * @description If provided, this value will be used when the Customer object is created. * If not provided, customers will be asked to enter their email address. * Use this parameter to prefill customer data if you already have an email @@ -11044,18 +11600,27 @@ export interface components { * complete, use the `customer` attribute. */ customer_email?: string | null; - /** @description List of coupons and promotion codes attached to the Checkout Session. */ + /** + * @nullable + * @description List of coupons and promotion codes attached to the Checkout Session. + */ discounts?: components["schemas"]["payment_pages_checkout_session_discount"][] | null; /** - * Format: unix-time * @description The timestamp at which the Checkout Session will expire. + * @format unix-time */ expires_at: number; /** @description Unique identifier for the object. */ id: string; - /** @description ID of the invoice created by the Checkout Session, if it exists. */ + /** + * @nullable + * @description ID of the invoice created by the Checkout Session, if it exists. + */ invoice?: (string | components["schemas"]["invoice"]) | null; - /** @description Details on the state of invoice creation for the Checkout Session. */ + /** + * @nullable + * @description Details on the state of invoice creation for the Checkout Session. + */ invoice_creation?: components["schemas"]["payment_pages_checkout_session_invoice_creation"] | null; /** * PaymentPagesCheckoutSessionListLineItems @@ -11077,11 +11642,15 @@ export interface components { /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; /** + * @nullable * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string|null} */ locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-GB" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW" | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -11095,18 +11664,31 @@ export interface components { * @enum {string} */ object: "checkout.session"; - /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. */ + /** + * @nullable + * @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; - /** @description The ID of the Payment Link that created this Session. */ + /** + * @nullable + * @description The ID of the Payment Link that created this Session. + */ payment_link?: (string | components["schemas"]["payment_link"]) | null; /** + * @nullable * @description Configure whether a Checkout Session should collect a payment method. Defaults to `always`. * @enum {string|null} */ payment_method_collection?: "always" | "if_required" | null; - /** @description Information about the payment method configuration used for this Checkout session if using dynamic payment methods. */ + /** + * @nullable + * @description Information about the payment method configuration used for this Checkout session if using dynamic payment methods. + */ payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; - /** @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ + /** + * @nullable + * @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. + */ payment_method_options?: components["schemas"]["checkout_session_payment_method_options"] | null; /** * @description A list of the types of payment methods (e.g. card) this Checkout @@ -11120,7 +11702,10 @@ export interface components { */ payment_status: "no_payment_required" | "paid" | "unpaid"; phone_number_collection?: components["schemas"]["payment_pages_checkout_session_phone_number_collection"]; - /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ + /** + * @nullable + * @description The ID of the original expired Checkout Session that triggered the recovery flow. + */ recovered_from?: string | null; /** * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. @@ -11129,46 +11714,72 @@ export interface components { redirect_on_completion?: "always" | "if_required" | "never"; /** @description Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. */ return_url?: string; - /** @description Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. */ + /** + * @nullable + * @description Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. + */ saved_payment_method_options?: components["schemas"]["payment_pages_checkout_session_saved_payment_method_options"] | null; - /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. */ + /** + * @nullable + * @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + */ setup_intent?: (string | components["schemas"]["setup_intent"]) | null; - /** @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ + /** + * @nullable + * @description When set, provides configuration for Checkout to collect a shipping address from a customer. + */ shipping_address_collection?: components["schemas"]["payment_pages_checkout_session_shipping_address_collection"] | null; - /** @description The details of the customer cost of shipping, including the customer chosen ShippingRate. */ + /** + * @nullable + * @description The details of the customer cost of shipping, including the customer chosen ShippingRate. + */ shipping_cost?: components["schemas"]["payment_pages_checkout_session_shipping_cost"] | null; - /** @description Shipping information for this Checkout Session. */ + /** + * @nullable + * @description Shipping information for this Checkout Session. + */ shipping_details?: components["schemas"]["shipping"] | null; /** @description The shipping rate options applied to this Session. */ shipping_options: components["schemas"]["payment_pages_checkout_session_shipping_option"][]; /** + * @nullable * @description The status of the Checkout Session, one of `open`, `complete`, or `expired`. * @enum {string|null} */ status?: "complete" | "expired" | "open" | null; /** + * @nullable * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be * specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. * @enum {string|null} */ submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe" | null; - /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ + /** + * @nullable + * @description The ID of the subscription for Checkout Sessions in `subscription` mode. + */ subscription?: (string | components["schemas"]["subscription"]) | null; /** + * @nullable * @description The URL the customer will be directed to after the payment or * subscription creation is successful. */ success_url?: string | null; tax_id_collection?: components["schemas"]["payment_pages_checkout_session_tax_id_collection"]; - /** @description Tax and discount details for the computed total amount. */ + /** + * @nullable + * @description Tax and discount details for the computed total amount. + */ total_details?: components["schemas"]["payment_pages_checkout_session_total_details"] | null; /** + * @nullable * @description The UI mode of the Session. Defaults to `hosted`. * @enum {string|null} */ ui_mode?: "embedded" | "hosted" | null; /** + * @nullable * @description The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.` * This value is only present when the session is active. */ @@ -11180,14 +11791,19 @@ export interface components { custom_mandate_url?: string; /** @description List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. */ default_for?: ("invoice" | "subscription")[]; - /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /** + * @nullable + * @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. + */ interval_description?: string | null; /** + * @nullable * @description Payment schedule for the mandate. * @enum {string|null} */ payment_schedule?: "combined" | "interval" | "sporadic" | null; /** + * @nullable * @description Transaction type of the mandate. * @enum {string|null} */ @@ -11406,6 +12022,7 @@ export interface components { */ requested_address_types?: ("aba" | "iban" | "sepa" | "sort_code" | "spei" | "swift" | "zengin")[]; /** + * @nullable * @description The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. * @enum {string|null} */ @@ -11415,6 +12032,7 @@ export interface components { checkout_customer_balance_payment_method_options: { bank_transfer?: components["schemas"]["checkout_customer_balance_bank_transfer_payment_method_options"]; /** + * @nullable * @description The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. * @enum {string|null} */ @@ -11536,7 +12154,10 @@ export interface components { }; /** CheckoutKonbiniPaymentMethodOptions */ checkout_konbini_payment_method_options: { - /** @description The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. */ + /** + * @nullable + * @description The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. + */ expires_after_days?: number | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -11688,9 +12309,15 @@ export interface components { * @enum {string} */ capture_method?: "manual"; - /** @description Preferred locale of the PayPal checkout page that the customer is redirected to. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. @@ -11706,7 +12333,10 @@ export interface components { }; /** CheckoutPixPaymentMethodOptions */ checkout_pix_payment_method_options: { - /** @description The number of seconds after which Pix payment will expire. */ + /** + * @nullable + * @description The number of seconds after which Pix payment will expire. + */ expires_after_seconds?: number | null; }; /** CheckoutRevolutPayPaymentMethodOptions */ @@ -11802,7 +12432,10 @@ export interface components { }; /** CheckoutSwishPaymentMethodOptions */ checkout_swish_payment_method_options: { - /** @description The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. */ + /** + * @nullable + * @description The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. + */ reference?: string | null; }; /** CheckoutUsBankAccountPaymentMethodOptions */ @@ -11839,37 +12472,45 @@ export interface components { amount_total: number; beneficiary?: components["schemas"]["climate_removals_beneficiary"]; /** - * Format: unix-time + * @nullable * @description Time at which the order was canceled. Measured in seconds since the Unix epoch. + * @format unix-time */ canceled_at?: number | null; /** + * @nullable * @description Reason for the cancellation of this order. * @enum {string|null} */ cancellation_reason?: "expired" | "product_unavailable" | "requested" | null; - /** @description For delivered orders, a URL to a delivery certificate for the order. */ + /** + * @nullable + * @description For delivered orders, a URL to a delivery certificate for the order. + */ certificate?: string | null; /** - * Format: unix-time + * @nullable * @description Time at which the order was confirmed. Measured in seconds since the Unix epoch. + * @format unix-time */ confirmed_at?: number | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order. */ currency: string; /** - * Format: unix-time + * @nullable * @description Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch. + * @format unix-time */ delayed_at?: number | null; /** - * Format: unix-time + * @nullable * @description Time at which the order was delivered. Measured in seconds since the Unix epoch. + * @format unix-time */ delivered_at?: number | null; /** @description Details about the delivery of carbon removal for this order. */ @@ -11885,8 +12526,8 @@ export interface components { [key: string]: string; }; /** - * Format: decimal * @description Quantity of carbon removal that is included in this order. + * @format decimal */ metric_tons: string; /** @@ -11897,8 +12538,9 @@ export interface components { /** @description Unique ID for the Climate `Product` this order is purchasing. */ product: string | components["schemas"]["climate.product"]; /** - * Format: unix-time + * @nullable * @description Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch. + * @format unix-time */ product_substituted_at?: number | null; /** @@ -11914,15 +12556,18 @@ export interface components { */ "climate.product": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Current prices for a metric ton of carbon removal in a currency's smallest unit. */ current_prices_per_metric_ton: { [key: string]: components["schemas"]["climate_removals_products_price"]; }; - /** @description The year in which the carbon removal is expected to be delivered. */ + /** + * @nullable + * @description The year in which the carbon removal is expected to be delivered. + */ delivery_year?: number | null; /** * @description Unique identifier for the object. For convenience, Climate product IDs are human-readable strings @@ -11933,8 +12578,8 @@ export interface components { /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; /** - * Format: decimal * @description The quantity of metric tons available for reservation. + * @format decimal */ metric_tons_available: string; /** @description The Climate product's name. */ @@ -11980,15 +12625,27 @@ export interface components { }; /** ClimateRemovalsLocation */ climate_removals_location: { - /** @description The city where the supplier is located. */ + /** + * @nullable + * @description The city where the supplier is located. + */ city?: string | null; /** @description Two-letter ISO code representing the country where the supplier is located. */ country: string; - /** @description The geographic latitude where the supplier is located. */ + /** + * @nullable + * @description The geographic latitude where the supplier is located. + */ latitude?: number | null; - /** @description The geographic longitude where the supplier is located. */ + /** + * @nullable + * @description The geographic longitude where the supplier is located. + */ longitude?: number | null; - /** @description The state/county/province/region where the supplier is located. */ + /** + * @nullable + * @description The state/county/province/region where the supplier is located. + */ region?: string | null; }; /** @@ -11997,15 +12654,21 @@ export interface components { */ climate_removals_order_deliveries: { /** - * Format: unix-time * @description Time at which the delivery occurred. Measured in seconds since the Unix epoch. + * @format unix-time */ delivered_at: number; - /** @description Specific location of this delivery. */ + /** + * @nullable + * @description Specific location of this delivery. + */ location?: components["schemas"]["climate_removals_location"] | null; /** @description Quantity of carbon removal supplied by this delivery. */ metric_tons: string; - /** @description Once retired, a URL to the registry entry for the tons from this delivery. */ + /** + * @nullable + * @description Once retired, a URL to the registry entry for the tons from this delivery. + */ registry_url?: string | null; supplier: components["schemas"]["climate.supplier"]; }; @@ -12030,44 +12693,67 @@ export interface components { */ confirmation_token: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time + * @nullable * @description Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. + * @format unix-time */ 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 Data used for generating a Mandate. */ + /** + * @nullable + * @description Data used for generating a Mandate. + */ mandate_data?: components["schemas"]["confirmation_tokens_resource_mandate_data"] | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "confirmation_token"; - /** @description ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. */ + /** + * @nullable + * @description ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. + */ payment_intent?: string | null; - /** @description Payment-method-specific configuration for this ConfirmationToken. */ + /** + * @nullable + * @description Payment-method-specific configuration for this ConfirmationToken. + */ payment_method_options?: components["schemas"]["confirmation_tokens_resource_payment_method_options"] | null; - /** @description Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. */ + /** + * @nullable + * @description Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. + */ payment_method_preview?: components["schemas"]["confirmation_tokens_resource_payment_method_preview"] | null; - /** @description Return URL used to confirm the Intent. */ + /** + * @nullable + * @description Return URL used to confirm the Intent. + */ return_url?: string | null; /** + * @nullable * @description Indicates that you intend to make future payments with this ConfirmationToken's payment method. * * The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; - /** @description ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. */ + /** + * @nullable + * @description ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. + */ setup_intent?: string | null; - /** @description Shipping information collected on this ConfirmationToken. */ + /** + * @nullable + * @description Shipping information collected on this ConfirmationToken. + */ shipping?: components["schemas"]["confirmation_tokens_resource_shipping"] | null; /** @description Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken. */ use_stripe_sdk: boolean; @@ -12084,7 +12770,10 @@ export interface components { * @description This hash contains details about the customer acceptance of the Mandate. */ confirmation_tokens_resource_mandate_data_resource_customer_acceptance: { - /** @description If this is a Mandate accepted online, this hash contains details about the online acceptance. */ + /** + * @nullable + * @description If this is a Mandate accepted online, this hash contains details about the online acceptance. + */ online?: components["schemas"]["confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online"] | null; /** @description The type of customer acceptance information included with the Mandate. */ type: string; @@ -12094,9 +12783,15 @@ export interface components { * @description This hash contains details about the online acceptance. */ confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online: { - /** @description The IP address from which the Mandate was accepted by the customer. */ + /** + * @nullable + * @description The IP address from which the Mandate was accepted by the customer. + */ ip_address?: string | null; - /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ + /** + * @nullable + * @description The user agent of the browser from which the Mandate was accepted by the customer. + */ user_agent?: string | null; }; /** @@ -12104,7 +12799,10 @@ export interface components { * @description Payment-method-specific configuration */ confirmation_tokens_resource_payment_method_options: { - /** @description This hash contains the card payment method options. */ + /** + * @nullable + * @description This hash contains the card payment method options. + */ card?: components["schemas"]["confirmation_tokens_resource_payment_method_options_resource_card"] | null; }; /** @@ -12112,7 +12810,10 @@ export interface components { * @description This hash contains the card payment method options. */ confirmation_tokens_resource_payment_method_options_resource_card: { - /** @description The `cvc_update` Token collected from the Payment Element. */ + /** + * @nullable + * @description The `cvc_update` Token collected from the Payment Element. + */ cvc_token?: string | null; }; /** @@ -12140,7 +12841,10 @@ export interface components { card?: components["schemas"]["payment_method_card"]; card_present?: components["schemas"]["payment_method_card_present"]; cashapp?: components["schemas"]["payment_method_cashapp"]; - /** @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. */ + /** + * @nullable + * @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. + */ customer?: (string | components["schemas"]["customer"]) | null; customer_balance?: components["schemas"]["payment_method_customer_balance"]; eps?: components["schemas"]["payment_method_eps"]; @@ -12185,7 +12889,10 @@ export interface components { address: components["schemas"]["address"]; /** @description Recipient name. */ name: string; - /** @description Recipient phone (including extension). */ + /** + * @nullable + * @description Recipient phone (including extension). + */ phone?: string | null; }; /** ConnectAccountReference */ @@ -12203,8 +12910,8 @@ export interface components { /** @description Amount transferred, in cents (or local equivalent). */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description ID of the account that funds are being collected for. */ @@ -12408,17 +13115,21 @@ export interface components { * [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents). */ coupon: { - /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ + /** + * @nullable + * @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. + */ amount_off?: number | null; applies_to?: components["schemas"]["coupon_applies_to"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency + * @nullable * @description If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. + * @format currency */ currency?: string | null; /** @description Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ @@ -12430,30 +13141,46 @@ export interface components { * @enum {string} */ duration: "forever" | "once" | "repeating"; - /** @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ + /** + * @nullable + * @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. + */ duration_in_months?: 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 Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ + /** + * @nullable + * @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. + */ max_redemptions?: number | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ + /** + * @nullable + * @description Name of the coupon displayed to customers on for instance invoices or receipts. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "coupon"; - /** @description Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. */ + /** + * @nullable + * @description Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. + */ percent_off?: number | null; /** - * Format: unix-time + * @nullable * @description Date after which the coupon can no longer be redeemed. + * @format unix-time */ redeem_by?: number | null; /** @description Number of times this coupon has been applied to a customer. */ @@ -12488,26 +13215,30 @@ export interface components { /** @description This is the sum of all the shipping amounts. */ amount_shipping: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description ID of the customer. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; - /** @description Customer balance transaction related to this credit note. */ + /** + * @nullable + * @description Customer balance transaction related to this credit note. + */ customer_balance_transaction?: (string | components["schemas"]["customer_balance_transaction"]) | null; /** @description The integer amount in cents (or local equivalent) representing the total amount of discount that was credited. */ discount_amount: number; /** @description The aggregate amounts calculated per discount for all line items. */ discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; /** - * Format: unix-time + * @nullable * @description The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. + * @format unix-time */ effective_at?: number | null; /** @description Unique identifier for the object. */ @@ -12533,9 +13264,15 @@ export interface components { }; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Customer-facing text that appears on the credit note PDF. */ + /** + * @nullable + * @description Customer-facing text that appears on the credit note PDF. + */ memo?: string | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -12546,20 +13283,30 @@ export interface components { * @enum {string} */ object: "credit_note"; - /** @description Amount that was credited outside of Stripe. */ + /** + * @nullable + * @description Amount that was credited outside of Stripe. + */ out_of_band_amount?: number | null; /** @description The link to download the PDF of the credit note. */ pdf: string; /** @description The pretax credit amounts (ex: discount, credit grants, etc) for all line items. */ pretax_credit_amounts: components["schemas"]["credit_notes_pretax_credit_amount"][]; /** + * @nullable * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string|null} */ reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory" | null; - /** @description Refund related to this credit note. */ + /** + * @nullable + * @description Refund related to this credit note. + */ refund?: (string | components["schemas"]["refund"]) | null; - /** @description The details of the cost of shipping, including the ShippingRate applied to the invoice. */ + /** + * @nullable + * @description The details of the cost of shipping, including the ShippingRate applied to the invoice. + */ shipping_cost?: components["schemas"]["invoices_resource_shipping_cost"] | null; /** * @description Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). @@ -12568,13 +13315,19 @@ export interface components { status: "issued" | "void"; /** @description The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts. */ subtotal: number; - /** @description The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. + */ subtotal_excluding_tax?: number | null; /** @description The aggregate amounts calculated per tax rate for all line items. */ tax_amounts: components["schemas"]["credit_note_tax_amount"][]; /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount. */ total: number; - /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. + */ total_excluding_tax?: number | null; /** * @description Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. @@ -12582,8 +13335,9 @@ export interface components { */ type: "post_payment" | "pre_payment"; /** - * Format: unix-time + * @nullable * @description The time that the credit note was voided. + * @format unix-time */ voided_at?: number | null; }; @@ -12594,9 +13348,15 @@ export interface components { credit_note_line_item: { /** @description The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ amount: number; - /** @description The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. + */ amount_excluding_tax?: number | null; - /** @description Description of the item being credited. */ + /** + * @nullable + * @description Description of the item being credited. + */ description?: string | null; /** @description The integer amount in cents (or local equivalent) representing the discount being credited for this line item. */ discount_amount: number; @@ -12615,7 +13375,10 @@ export interface components { object: "credit_note_line_item"; /** @description The pretax credit amounts (ex: discount, credit grants, etc) for this line item. */ pretax_credit_amounts: components["schemas"]["credit_notes_pretax_credit_amount"][]; - /** @description The number of units of product being credited. */ + /** + * @nullable + * @description The number of units of product being credited. + */ quantity?: number | null; /** @description The amount of tax calculated per tax rate for this line item */ tax_amounts: components["schemas"]["credit_note_tax_amount"][]; @@ -12626,16 +13389,21 @@ export interface components { * @enum {string} */ type: "custom_line_item" | "invoice_line_item"; - /** @description The cost of each unit of product being credited. */ + /** + * @nullable + * @description The cost of each unit of product being credited. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ unit_amount_decimal?: string | null; /** - * Format: decimal + * @nullable * @description The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts. + * @format decimal */ unit_amount_excluding_tax?: string | null; }; @@ -12648,11 +13416,15 @@ export interface components { /** @description The tax rate that was applied to get this tax amount. */ tax_rate: string | components["schemas"]["tax_rate"]; /** + * @nullable * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. * @enum {string|null} */ taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in cents (or local equivalent). */ + /** + * @nullable + * @description The amount on which tax is calculated, in cents (or local equivalent). + */ taxable_amount?: number | null; }; /** CreditNotesPretaxCreditAmount */ @@ -12671,30 +13443,47 @@ export interface components { }; /** CurrencyOption */ currency_option: { - /** @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. */ + /** + * @nullable + * @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. + */ custom_unit_amount?: components["schemas"]["custom_unit_amount"] | null; /** + * @nullable * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string|null} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified" | null; /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: components["schemas"]["price_tier"][]; - /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /** + * @nullable + * @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * @format decimal */ unit_amount_decimal?: string | null; }; /** CustomUnitAmount */ custom_unit_amount: { - /** @description The maximum unit amount the customer can specify for this item. */ + /** + * @nullable + * @description The maximum unit amount the customer can specify for this item. + */ maximum?: number | null; - /** @description The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. */ + /** + * @nullable + * @description The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. + */ minimum?: number | null; - /** @description The starting unit amount which can be updated by the customer. */ + /** + * @nullable + * @description The starting unit amount which can be updated by the customer. + */ preset?: number | null; }; /** @@ -12703,26 +13492,37 @@ export interface components { * and track payments that belong to the same customer. */ customer: { - /** @description The customer's address. */ + /** + * @nullable + * @description The customer's address. + */ address?: components["schemas"]["address"] | null; /** @description The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. */ balance?: number; - /** @description The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically. */ + /** + * @nullable + * @description The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically. + */ cash_balance?: components["schemas"]["cash_balance"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ + /** + * @nullable + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. + */ currency?: string | null; /** + * @nullable * @description ID of the default payment source for the customer. * * If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. */ default_source?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]) | null; /** + * @nullable * @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`. @@ -12730,11 +13530,20 @@ export interface components { * 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. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Describes the current discount active on the customer, if there is one. */ + /** + * @nullable + * @description Describes the current discount active on the customer, if there is one. + */ discount?: components["schemas"]["discount"] | null; - /** @description The customer's email address. */ + /** + * @nullable + * @description The customer's email address. + */ email?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -12742,7 +13551,10 @@ export interface components { invoice_credit_balance?: { [key: string]: number; }; - /** @description The prefix for the customer used to generate unique invoice numbers. */ + /** + * @nullable + * @description The prefix for the customer used to generate unique invoice numbers. + */ invoice_prefix?: string | null; invoice_settings?: components["schemas"]["invoice_setting_customer_setting"]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -12751,7 +13563,10 @@ export interface components { metadata?: { [key: string]: string; }; - /** @description The customer's full name or business name. */ + /** + * @nullable + * @description The customer's full name or business name. + */ name?: string | null; /** @description The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. */ next_invoice_sequence?: number; @@ -12760,11 +13575,20 @@ export interface components { * @enum {string} */ object: "customer"; - /** @description The customer's phone number. */ + /** + * @nullable + * @description The customer's phone number. + */ phone?: string | null; - /** @description The customer's preferred locales (languages), ordered by preference. */ + /** + * @nullable + * @description The customer's preferred locales (languages), ordered by preference. + */ preferred_locales?: string[] | null; - /** @description Mailing and shipping address for the customer. Appears on invoices emailed to this customer. */ + /** + * @nullable + * @description Mailing and shipping address for the customer. Appears on invoices emailed to this customer. + */ shipping?: components["schemas"]["shipping"] | null; /** * ApmsSourcesSourceList @@ -12802,6 +13626,7 @@ export interface components { }; tax?: components["schemas"]["customer_tax"]; /** + * @nullable * @description Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. * @enum {string|null} */ @@ -12823,14 +13648,18 @@ export interface components { /** @description The URL where this list can be accessed. */ url: string; }; - /** @description ID of the test clock that this customer belongs to. */ + /** + * @nullable + * @description ID of the test clock that this customer belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; }; /** customer_acceptance */ customer_acceptance: { /** - * Format: unix-time + * @nullable * @description The time that the customer accepts the mandate. + * @format unix-time */ accepted_at?: number | null; offline?: components["schemas"]["offline_acceptance"]; @@ -12872,7 +13701,10 @@ export interface components { eu_bank_transfer?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer"]; gb_bank_transfer?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer"]; jp_bank_transfer?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer"]; - /** @description The user-supplied reference field on the bank transfer. */ + /** + * @nullable + * @description The user-supplied reference field on the bank transfer. + */ reference?: string | null; /** * @description The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. @@ -12883,29 +13715,56 @@ export interface components { }; /** CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer */ customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer: { - /** @description The BIC of the bank of the sender of the funding. */ + /** + * @nullable + * @description The BIC of the bank of the sender of the funding. + */ bic?: string | null; - /** @description The last 4 digits of the IBAN of the sender of the funding. */ + /** + * @nullable + * @description The last 4 digits of the IBAN of the sender of the funding. + */ iban_last4?: string | null; - /** @description The full name of the sender, as supplied by the sending bank. */ + /** + * @nullable + * @description The full name of the sender, as supplied by the sending bank. + */ sender_name?: string | null; }; /** CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer */ customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer: { - /** @description The last 4 digits of the account number of the sender of the funding. */ + /** + * @nullable + * @description The last 4 digits of the account number of the sender of the funding. + */ account_number_last4?: string | null; - /** @description The full name of the sender, as supplied by the sending bank. */ + /** + * @nullable + * @description The full name of the sender, as supplied by the sending bank. + */ sender_name?: string | null; - /** @description The sort code of the bank of the sender of the funding */ + /** + * @nullable + * @description The sort code of the bank of the sender of the funding + */ sort_code?: string | null; }; /** CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer */ customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer: { - /** @description The name of the bank of the sender of the funding. */ + /** + * @nullable + * @description The name of the bank of the sender of the funding. + */ sender_bank?: string | null; - /** @description The name of the bank branch of the sender of the funding. */ + /** + * @nullable + * @description The name of the bank branch of the sender of the funding. + */ sender_branch?: string | null; - /** @description The full name of the sender, as supplied by the sending bank. */ + /** + * @nullable + * @description The full name of the sender, as supplied by the sending bank. + */ sender_name?: string | null; }; /** CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer */ @@ -12915,7 +13774,10 @@ export interface components { * @enum {string} */ network?: "ach" | "domestic_wire_us" | "swift"; - /** @description The full name of the sender, as supplied by the sending bank. */ + /** + * @nullable + * @description The full name of the sender, as supplied by the sending bank. + */ sender_name?: string | null; }; /** CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction */ @@ -12946,30 +13808,42 @@ export interface components { /** @description The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The ID of the credit note (if any) related to the transaction. */ + /** + * @nullable + * @description The ID of the credit note (if any) related to the transaction. + */ credit_note?: (string | components["schemas"]["credit_note"]) | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The ID of the customer the transaction belongs to. */ customer: string | components["schemas"]["customer"]; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. */ ending_balance: number; /** @description Unique identifier for the object. */ id: string; - /** @description The ID of the invoice (if any) related to the transaction. */ + /** + * @nullable + * @description The ID of the invoice (if any) related to the transaction. + */ invoice?: (string | components["schemas"]["invoice"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -12995,8 +13869,8 @@ export interface components { adjusted_for_overdraft?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft"]; applied_to_payment?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ 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). */ @@ -13044,15 +13918,15 @@ export interface components { client_secret: string; components?: components["schemas"]["customer_session_resource_components"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The Customer the Customer Session was created for. */ customer: string | components["schemas"]["customer"]; /** - * Format: unix-time * @description The timestamp at which this Customer Session will expire. + * @format unix-time */ expires_at: number; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -13087,7 +13961,10 @@ export interface components { customer_session_resource_components_resource_payment_element: { /** @description Whether the Payment Element is enabled. */ enabled: boolean; - /** @description This hash defines whether the Payment Element supports certain features. */ + /** + * @nullable + * @description This hash defines whether the Payment Element supports certain features. + */ features?: components["schemas"]["customer_session_resource_components_resource_payment_element_resource_features"] | null; }; /** @@ -13106,7 +13983,10 @@ export interface components { * @enum {string} */ payment_method_redisplay: "disabled" | "enabled"; - /** @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. */ + /** + * @nullable + * @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. + */ payment_method_redisplay_limit?: number | null; /** * @description Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`. @@ -13123,6 +14003,7 @@ export interface components { */ payment_method_save: "disabled" | "enabled"; /** + * @nullable * @description When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent. * * When using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation. @@ -13145,9 +14026,15 @@ export interface components { * @enum {string} */ automatic_tax: "failed" | "not_collecting" | "supported" | "unrecognized_location"; - /** @description A recent IP address of the customer used for tax reporting and tax location inference. */ + /** + * @nullable + * @description A recent IP address of the customer used for tax reporting and tax location inference. + */ ip_address?: string | null; - /** @description The customer's location as identified by Stripe Tax. */ + /** + * @nullable + * @description The customer's location as identified by Stripe Tax. + */ location?: components["schemas"]["customer_tax_location"] | null; }; /** CustomerTaxLocation */ @@ -13159,7 +14046,10 @@ export interface components { * @enum {string} */ source: "billing_address" | "ip_address" | "payment_method" | "shipping_destination"; - /** @description The customer's state, county, province, or region as identified by Stripe Tax. */ + /** + * @nullable + * @description The customer's state, county, province, or region as identified by Stripe Tax. + */ state?: string | null; }; /** DeletedAccount */ @@ -13201,7 +14091,10 @@ export interface components { deleted: true; /** @description Unique identifier for the object. */ id: string; - /** @description The name of the application. */ + /** + * @nullable + * @description The name of the application. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -13211,7 +14104,10 @@ export interface components { }; /** DeletedBankAccount */ deleted_bank_account: { - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ + /** + * @nullable + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. + */ currency?: string | null; /** * @description Always true for a deleted object @@ -13228,7 +14124,10 @@ export interface components { }; /** DeletedCard */ deleted_card: { - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ + /** + * @nullable + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. + */ currency?: string | null; /** * @description Always true for a deleted object @@ -13275,10 +14174,16 @@ export interface components { }; /** DeletedDiscount */ deleted_discount: { - /** @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. */ + /** + * @nullable + * @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. + */ checkout_session?: string | null; coupon: components["schemas"]["coupon"]; - /** @description The ID of the customer associated with this discount. */ + /** + * @nullable + * @description The ID of the customer associated with this discount. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** * @description Always true for a deleted object @@ -13287,25 +14192,40 @@ export interface components { deleted: true; /** @description The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. */ id: string; - /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ + /** + * @nullable + * @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. + */ invoice?: string | null; - /** @description The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. */ + /** + * @nullable + * @description The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. + */ invoice_item?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "discount"; - /** @description The promotion code applied to create this discount. */ + /** + * @nullable + * @description The promotion code applied to create this discount. + */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; /** - * Format: unix-time * @description Date that the coupon was applied. + * @format unix-time */ start: number; - /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ + /** + * @nullable + * @description The subscription that this coupon is applied to, if it is applied to a particular subscription. + */ subscription?: string | null; - /** @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. */ + /** + * @nullable + * @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. + */ subscription_item?: string | null; }; /** Polymorphic */ @@ -13562,37 +14482,59 @@ export interface components { * Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) */ discount: { - /** @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. */ + /** + * @nullable + * @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. + */ checkout_session?: string | null; coupon: components["schemas"]["coupon"]; - /** @description The ID of the customer associated with this discount. */ + /** + * @nullable + * @description The ID of the customer associated with this discount. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** - * Format: unix-time + * @nullable * @description If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. + * @format unix-time */ end?: number | null; /** @description The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. */ id: string; - /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ + /** + * @nullable + * @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. + */ invoice?: string | null; - /** @description The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. */ + /** + * @nullable + * @description The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. + */ invoice_item?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "discount"; - /** @description The promotion code applied to create this discount. */ + /** + * @nullable + * @description The promotion code applied to create this discount. + */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; /** - * Format: unix-time * @description Date that the coupon was applied. + * @format unix-time */ start: number; - /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ + /** + * @nullable + * @description The subscription that this coupon is applied to, if it is applied to a particular subscription. + */ subscription?: string | null; - /** @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. */ + /** + * @nullable + * @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. + */ subscription_item?: string | null; }; /** DiscountsResourceDiscountAmount */ @@ -13604,11 +14546,20 @@ export interface components { }; /** DiscountsResourceStackableDiscount */ discounts_resource_stackable_discount: { - /** @description ID of the coupon to create a new discount for. */ + /** + * @nullable + * @description ID of the coupon to create a new discount for. + */ coupon?: (string | components["schemas"]["coupon"]) | null; - /** @description ID of an existing discount on the object (or one of its ancestors) to reuse. */ + /** + * @nullable + * @description ID of an existing discount on the object (or one of its ancestors) to reuse. + */ discount?: (string | components["schemas"]["discount"]) | null; - /** @description ID of the promotion code to create a new discount for. */ + /** + * @nullable + * @description ID of the promotion code to create a new discount for. + */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; }; /** @@ -13627,13 +14578,13 @@ export interface components { /** @description ID of the charge that's disputed. */ charge: string | components["schemas"]["charge"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description List of eligibility types that are included in `enhanced_evidence`. */ @@ -13655,7 +14606,10 @@ export interface components { * @enum {string} */ object: "dispute"; - /** @description ID of the PaymentIntent that's disputed. */ + /** + * @nullable + * @description ID of the PaymentIntent that's disputed. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; payment_method_details?: components["schemas"]["dispute_payment_method_details"]; /** @description Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ @@ -13696,7 +14650,10 @@ export interface components { }; /** DisputeEnhancedEvidenceVisaCompellingEvidence3 */ dispute_enhanced_evidence_visa_compelling_evidence3: { - /** @description Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. */ + /** + * @nullable + * @description Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. + */ disputed_transaction?: components["schemas"]["dispute_visa_compelling_evidence3_disputed_transaction"] | null; /** @description List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission. */ prior_undisputed_transactions: components["schemas"]["dispute_visa_compelling_evidence3_prior_undisputed_transaction"][]; @@ -13708,67 +14665,149 @@ export interface components { }; /** DisputeEvidence */ dispute_evidence: { - /** @description Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. */ + /** + * @nullable + * @description Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. + */ access_activity_log?: string | null; - /** @description The billing address provided by the customer. */ + /** + * @nullable + * @description The billing address provided by the customer. + */ billing_address?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. + */ cancellation_policy?: (string | components["schemas"]["file"]) | null; - /** @description An explanation of how and when the customer was shown your refund policy prior to purchase. */ + /** + * @nullable + * @description An explanation of how and when the customer was shown your refund policy prior to purchase. + */ cancellation_policy_disclosure?: string | null; - /** @description A justification for why the customer's subscription was not canceled. */ + /** + * @nullable + * @description A justification for why the customer's subscription was not canceled. + */ cancellation_rebuttal?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. + */ customer_communication?: (string | components["schemas"]["file"]) | null; - /** @description The email address of the customer. */ + /** + * @nullable + * @description The email address of the customer. + */ customer_email_address?: string | null; - /** @description The name of the customer. */ + /** + * @nullable + * @description The name of the customer. + */ customer_name?: string | null; - /** @description The IP address that the customer used when making the purchase. */ + /** + * @nullable + * @description The IP address that the customer used when making the purchase. + */ customer_purchase_ip?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. + */ customer_signature?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. + */ duplicate_charge_documentation?: (string | components["schemas"]["file"]) | null; - /** @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ + /** + * @nullable + * @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. + */ duplicate_charge_explanation?: string | null; - /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ + /** + * @nullable + * @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. + */ duplicate_charge_id?: string | null; enhanced_evidence: components["schemas"]["dispute_enhanced_evidence"]; - /** @description A description of the product or service that was sold. */ + /** + * @nullable + * @description A description of the product or service that was sold. + */ product_description?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. + */ receipt?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. + */ refund_policy?: (string | components["schemas"]["file"]) | null; - /** @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ + /** + * @nullable + * @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. + */ refund_policy_disclosure?: string | null; - /** @description A justification for why the customer is not entitled to a refund. */ + /** + * @nullable + * @description A justification for why the customer is not entitled to a refund. + */ refund_refusal_explanation?: string | null; - /** @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ + /** + * @nullable + * @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. + */ service_date?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. + */ service_documentation?: (string | components["schemas"]["file"]) | null; - /** @description The address to which a physical product was shipped. You should try to include as complete address information as possible. */ + /** + * @nullable + * @description The address to which a physical product was shipped. You should try to include as complete address information as possible. + */ shipping_address?: string | null; - /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. */ + /** + * @nullable + * @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. + */ shipping_carrier?: string | null; - /** @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ + /** + * @nullable + * @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. + */ shipping_date?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. + */ shipping_documentation?: (string | components["schemas"]["file"]) | null; - /** @description The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. */ + /** + * @nullable + * @description The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. + */ shipping_tracking_number?: string | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. + */ uncategorized_file?: (string | components["schemas"]["file"]) | null; - /** @description Any additional evidence or statements. */ + /** + * @nullable + * @description Any additional evidence or statements. + */ uncategorized_text?: string | null; }; /** DisputeEvidenceDetails */ dispute_evidence_details: { /** - * Format: unix-time + * @nullable * @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute. + * @format unix-time */ due_by?: number | null; enhanced_eligibility: components["schemas"]["dispute_enhanced_eligibility"]; @@ -13794,6 +14833,7 @@ export interface components { /** DisputePaymentMethodDetailsAmazonPay */ dispute_payment_method_details_amazon_pay: { /** + * @nullable * @description The AmazonPay dispute type, chargeback or claim * @enum {string|null} */ @@ -13808,82 +14848,155 @@ export interface components { * @enum {string} */ case_type: "chargeback" | "inquiry"; - /** @description The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network. */ + /** + * @nullable + * @description The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network. + */ network_reason_code?: string | null; }; /** DisputePaymentMethodDetailsKlarna */ dispute_payment_method_details_klarna: { - /** @description The reason for the dispute as defined by Klarna */ + /** + * @nullable + * @description The reason for the dispute as defined by Klarna + */ reason_code?: string | null; }; /** DisputePaymentMethodDetailsPaypal */ dispute_payment_method_details_paypal: { - /** @description The ID of the dispute in PayPal. */ + /** + * @nullable + * @description The ID of the dispute in PayPal. + */ case_id?: string | null; - /** @description The reason for the dispute as defined by PayPal */ + /** + * @nullable + * @description The reason for the dispute as defined by PayPal + */ reason_code?: string | null; }; /** DisputeTransactionShippingAddress */ dispute_transaction_shipping_address: { - /** @description City, district, suburb, town, or village. */ + /** + * @nullable + * @description City, district, suburb, town, or village. + */ city?: string | null; - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; - /** @description Address line 1 (e.g., street, PO Box, or company name). */ + /** + * @nullable + * @description Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string | null; - /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + /** + * @nullable + * @description Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ postal_code?: string | null; - /** @description State, county, province, or region. */ + /** + * @nullable + * @description State, county, province, or region. + */ state?: string | null; }; /** DisputeVisaCompellingEvidence3DisputedTransaction */ dispute_visa_compelling_evidence3_disputed_transaction: { - /** @description User Account ID used to log into business platform. Must be recognizable by the user. */ + /** + * @nullable + * @description User Account ID used to log into business platform. Must be recognizable by the user. + */ customer_account_id?: string | null; - /** @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. */ + /** + * @nullable + * @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. + */ customer_device_fingerprint?: string | null; - /** @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. */ + /** + * @nullable + * @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. + */ customer_device_id?: string | null; - /** @description The email address of the customer. */ + /** + * @nullable + * @description The email address of the customer. + */ customer_email_address?: string | null; - /** @description The IP address that the customer used when making the purchase. */ + /** + * @nullable + * @description The IP address that the customer used when making the purchase. + */ customer_purchase_ip?: string | null; /** + * @nullable * @description Categorization of disputed payment. * @enum {string|null} */ merchandise_or_services?: "merchandise" | "services" | null; - /** @description A description of the product or service that was sold. */ + /** + * @nullable + * @description A description of the product or service that was sold. + */ product_description?: string | null; - /** @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. */ + /** + * @nullable + * @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. + */ shipping_address?: components["schemas"]["dispute_transaction_shipping_address"] | null; }; /** DisputeVisaCompellingEvidence3PriorUndisputedTransaction */ dispute_visa_compelling_evidence3_prior_undisputed_transaction: { /** @description Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge. */ charge: string; - /** @description User Account ID used to log into business platform. Must be recognizable by the user. */ + /** + * @nullable + * @description User Account ID used to log into business platform. Must be recognizable by the user. + */ customer_account_id?: string | null; - /** @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. */ + /** + * @nullable + * @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. + */ customer_device_fingerprint?: string | null; - /** @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. */ + /** + * @nullable + * @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. + */ customer_device_id?: string | null; - /** @description The email address of the customer. */ + /** + * @nullable + * @description The email address of the customer. + */ customer_email_address?: string | null; - /** @description The IP address that the customer used when making the purchase. */ + /** + * @nullable + * @description The IP address that the customer used when making the purchase. + */ customer_purchase_ip?: string | null; - /** @description A description of the product or service that was sold. */ + /** + * @nullable + * @description A description of the product or service that was sold. + */ product_description?: string | null; - /** @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. */ + /** + * @nullable + * @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. + */ shipping_address?: components["schemas"]["dispute_transaction_shipping_address"] | null; }; /** EmailSent */ email_sent: { /** - * Format: unix-time * @description The timestamp when the email was sent. + * @format unix-time */ email_sent_at: number; /** @description The recipient's email address. */ @@ -13937,13 +15050,13 @@ export interface components { /** EphemeralKey */ ephemeral_key: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time * @description Time at which the key will expire. Measured in seconds since the Unix epoch. + * @format unix-time */ expires: number; /** @description Unique identifier for the object. */ @@ -13998,11 +15111,14 @@ export interface components { event: { /** @description The connected account that originates the event. */ account?: string; - /** @description The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. */ + /** + * @nullable + * @description The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. + */ api_version?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; data: components["schemas"]["notification_event_data"]; @@ -14017,7 +15133,10 @@ export interface components { object: "event"; /** @description Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify. */ pending_webhooks: number; - /** @description Information on the API request that triggers the event. */ + /** + * @nullable + * @description Information on the API request that triggers the event. + */ request?: components["schemas"]["notification_event_request"] | null; /** @description Description of the event (for example, `invoice.created` or `charge.refunded`). */ type: string; @@ -14068,27 +15187,45 @@ export interface components { external_account: components["schemas"]["bank_account"] | components["schemas"]["card"]; /** ExternalAccountRequirements */ external_account_requirements: { - /** @description Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ + /** + * @nullable + * @description Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. + */ currently_due?: string[] | null; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** + * @nullable + * @description Fields that are `currently_due` and need to be collected again because validation or verification failed. + */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. */ + /** + * @nullable + * @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. + */ past_due?: string[] | null; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** + * @nullable + * @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. + */ pending_verification?: string[] | null; }; /** Fee */ fee: { /** @description Amount of the fee, in cents. */ amount: number; - /** @description ID of the Connect application that earned the fee. */ + /** + * @nullable + * @description ID of the Connect application that earned the fee. + */ application?: string | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`. */ type: string; @@ -14104,23 +15241,29 @@ export interface components { fee_refund: { /** @description Amount, in cents (or local equivalent). */ amount: number; - /** @description Balance transaction that describes the impact on your account balance. */ + /** + * @nullable + * @description Balance transaction that describes the impact on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description ID of the application fee that was refunded. */ fee: string | components["schemas"]["application_fee"]; /** @description Unique identifier for the object. */ id: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -14142,21 +15285,26 @@ export interface components { */ file: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time + * @nullable * @description The file expires and isn't available at this time in epoch seconds. + * @format unix-time */ expires_at?: number | null; - /** @description The suitable name for saving the file to a filesystem. */ + /** + * @nullable + * @description The suitable name for saving the file to a filesystem. + */ filename?: string | null; /** @description Unique identifier for the object. */ id: string; /** * FileResourceFileLinkList + * @nullable * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ links?: { @@ -14169,7 +15317,10 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/file_links + */ url: string; } | null; /** @@ -14184,11 +15335,20 @@ export interface components { purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "financial_account_statement" | "identity_document" | "identity_document_downloadable" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; /** @description The size of the file object in bytes. */ size: number; - /** @description A suitable title for the document. */ + /** + * @nullable + * @description A suitable title for the document. + */ title?: string | null; - /** @description The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). */ + /** + * @nullable + * @description The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). + */ type?: string | null; - /** @description Use your live secret API key to download the file from this URL. */ + /** + * @nullable + * @description Use your live secret API key to download the file from this URL. + */ url?: string | null; }; /** @@ -14199,15 +15359,16 @@ export interface components { */ file_link: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Returns if the link is already expired. */ expired: boolean; /** - * Format: unix-time + * @nullable * @description Time that the link expires. + * @format unix-time */ expires_at?: number | null; /** @description The file object this link points to. */ @@ -14225,7 +15386,10 @@ export interface components { * @enum {string} */ object: "file_link"; - /** @description The publicly accessible URL to download the file. */ + /** + * @nullable + * @description The publicly accessible URL to download the file. + */ url?: string | null; }; /** @@ -14233,11 +15397,20 @@ export interface components { * @description A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access. */ "financial_connections.account": { - /** @description The account holder that this account belongs to. */ + /** + * @nullable + * @description The account holder that this account belongs to. + */ account_holder?: components["schemas"]["bank_connections_resource_accountholder"] | null; - /** @description The most recent information about the account's balance. */ + /** + * @nullable + * @description The most recent information about the account's balance. + */ balance?: components["schemas"]["bank_connections_resource_balance"] | null; - /** @description The state of the most recent attempt to refresh the account balance. */ + /** + * @nullable + * @description The state of the most recent attempt to refresh the account balance. + */ balance_refresh?: components["schemas"]["bank_connections_resource_balance_refresh"] | null; /** * @description The type of the account. Account category is further divided in `subcategory`. @@ -14245,17 +15418,23 @@ export interface components { */ category: "cash" | "credit" | "investment" | "other"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description A human-readable name that has been assigned to this account, either by the account holder or by the institution. */ + /** + * @nullable + * @description A human-readable name that has been assigned to this account, either by the account holder or by the institution. + */ display_name?: string | null; /** @description Unique identifier for the object. */ id: string; /** @description The name of the institution that holds this account. */ institution_name: string; - /** @description The last 4 digits of the account number. If present, this will be 4 numeric characters. */ + /** + * @nullable + * @description The last 4 digits of the account number. If present, this will be 4 numeric characters. + */ last4?: string | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -14264,11 +15443,20 @@ export interface components { * @enum {string} */ object: "financial_connections.account"; - /** @description The most recent information about the account's owners. */ + /** + * @nullable + * @description The most recent information about the account's owners. + */ ownership?: (string | components["schemas"]["financial_connections.account_ownership"]) | null; - /** @description The state of the most recent attempt to refresh the account owners. */ + /** + * @nullable + * @description The state of the most recent attempt to refresh the account owners. + */ ownership_refresh?: components["schemas"]["bank_connections_resource_ownership_refresh"] | null; - /** @description The list of permissions granted by this account. */ + /** + * @nullable + * @description The list of permissions granted by this account. + */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[] | null; /** * @description The status of the link to the account. @@ -14293,11 +15481,17 @@ export interface components { * @enum {string} */ subcategory: "checking" | "credit_card" | "line_of_credit" | "mortgage" | "other" | "savings"; - /** @description The list of data refresh subscriptions requested on this account. */ + /** + * @nullable + * @description The list of data refresh subscriptions requested on this account. + */ subscriptions?: "transactions"[] | null; /** @description The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. */ supported_payment_method_types: ("link" | "us_bank_account")[]; - /** @description The state of the most recent attempt to refresh the account transactions. */ + /** + * @nullable + * @description The state of the most recent attempt to refresh the account transactions. + */ transaction_refresh?: components["schemas"]["bank_connections_resource_transaction_refresh"] | null; }; /** @@ -14305,7 +15499,10 @@ export interface components { * @description Describes an owner of an account. */ "financial_connections.account_owner": { - /** @description The email address of the owner. */ + /** + * @nullable + * @description The email address of the owner. + */ email?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -14318,13 +15515,20 @@ export interface components { object: "financial_connections.account_owner"; /** @description The ownership object that this owner belongs to. */ ownership: string; - /** @description The raw phone number of the owner. */ + /** + * @nullable + * @description The raw phone number of the owner. + */ phone?: string | null; - /** @description The raw physical address of the owner. */ + /** + * @nullable + * @description The raw physical address of the owner. + */ raw_address?: string | null; /** - * Format: unix-time + * @nullable * @description The timestamp of the refresh that updated this owner. + * @format unix-time */ refreshed_at?: number | null; }; @@ -14334,8 +15538,8 @@ export interface components { */ "financial_connections.account_ownership": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ @@ -14368,7 +15572,10 @@ export interface components { * @description A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts. */ "financial_connections.session": { - /** @description The account holder for whom accounts are collected in this session. */ + /** + * @nullable + * @description The account holder for whom accounts are collected in this session. + */ account_holder?: components["schemas"]["bank_connections_resource_accountholder"] | null; /** * BankConnectionsResourceLinkedAccountList @@ -14384,7 +15591,10 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/financial_connections/accounts + */ url: string; }; /** @description A value that will be passed to the client to launch the authentication flow. */ @@ -14401,7 +15611,10 @@ export interface components { object: "financial_connections.session"; /** @description Permissions requested for accounts collected during this session. */ permissions: ("balances" | "ownership" | "payment_method" | "transactions")[]; - /** @description Data features requested to be retrieved upon account creation. */ + /** + * @nullable + * @description Data features requested to be retrieved upon account creation. + */ prefetch?: ("balances" | "ownership" | "transactions")[] | null; /** @description For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ return_url?: string; @@ -14435,15 +15648,15 @@ export interface components { status: "pending" | "posted" | "void"; status_transitions: components["schemas"]["bank_connections_resource_transaction_resource_status_transitions"]; /** - * Format: unix-time * @description Time at which the transaction was transacted. Measured in seconds since the Unix epoch. + * @format unix-time */ transacted_at: number; /** @description The token of the transaction refresh that last updated or created this transaction. */ transaction_refresh: string; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; }; @@ -14454,18 +15667,18 @@ export interface components { /** @description Connected account ID by which to filter the report run. */ connected_account?: string; /** - * Format: currency * @description Currency of objects to be included in the report run. + * @format currency */ currency?: string; /** - * Format: unix-time * @description Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value. + * @format unix-time */ interval_end?: number; /** - * Format: unix-time * @description Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value. + * @format unix-time */ interval_start?: number; /** @description Payout ID by which to filter the report run. */ @@ -14543,15 +15756,18 @@ export interface components { */ "forwarding.request": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -14564,13 +15780,25 @@ export interface components { payment_method: string; /** @description The field kinds to be replaced in the forwarded request. */ replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name" | "request_signature")[]; - /** @description Context about the request from Stripe's servers to the destination endpoint. */ + /** + * @nullable + * @description Context about the request from Stripe's servers to the destination endpoint. + */ request_context?: components["schemas"]["forwarded_request_context"] | null; - /** @description The request that was sent to the destination endpoint. We redact any sensitive fields. */ + /** + * @nullable + * @description The request that was sent to the destination endpoint. We redact any sensitive fields. + */ request_details?: components["schemas"]["forwarded_request_details"] | null; - /** @description The response that the destination endpoint returned to us. We redact any sensitive fields. */ + /** + * @nullable + * @description The response that the destination endpoint returned to us. We redact any sensitive fields. + */ response_details?: components["schemas"]["forwarded_response_details"] | null; - /** @description The destination URL for the forwarded request. Must be supported by the config. */ + /** + * @nullable + * @description The destination URL for the forwarded request. Must be supported by the config. + */ url?: string | null; }; /** @@ -14717,20 +15945,41 @@ export interface components { */ funding_instructions_bank_transfer_zengin_record: { account_holder_address: components["schemas"]["address"]; - /** @description The account holder name */ + /** + * @nullable + * @description The account holder name + */ account_holder_name?: string | null; - /** @description The account number */ + /** + * @nullable + * @description The account number + */ account_number?: string | null; - /** @description The bank account type. In Japan, this can only be `futsu` or `toza`. */ + /** + * @nullable + * @description The bank account type. In Japan, this can only be `futsu` or `toza`. + */ account_type?: string | null; bank_address: components["schemas"]["address"]; - /** @description The bank code of the account */ + /** + * @nullable + * @description The bank code of the account + */ bank_code?: string | null; - /** @description The bank name of the account */ + /** + * @nullable + * @description The bank name of the account + */ bank_name?: string | null; - /** @description The branch code of the account */ + /** + * @nullable + * @description The branch code of the account + */ branch_code?: string | null; - /** @description The branch name of the account */ + /** + * @nullable + * @description The branch name of the account + */ branch_name?: string | null; }; /** @@ -14738,11 +15987,20 @@ export interface components { * @description Point in Time */ gelato_data_document_report_date_of_birth: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14750,11 +16008,20 @@ export interface components { * @description Point in Time */ gelato_data_document_report_expiration_date: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14762,11 +16029,20 @@ export interface components { * @description Point in Time */ gelato_data_document_report_issued_date: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14774,11 +16050,20 @@ export interface components { * @description Point in Time */ gelato_data_id_number_report_date: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14786,11 +16071,20 @@ export interface components { * @description Point in Time */ gelato_data_verified_outputs_date: { - /** @description Numerical day between 1 and 31. */ + /** + * @nullable + * @description Numerical day between 1 and 31. + */ day?: number | null; - /** @description Numerical month between 1 and 12. */ + /** + * @nullable + * @description Numerical month between 1 and 12. + */ month?: number | null; - /** @description The four-digit year. */ + /** + * @nullable + * @description The four-digit year. + */ year?: number | null; }; /** @@ -14798,25 +16092,55 @@ export interface components { * @description Result from a document check */ gelato_document_report: { - /** @description Address as it appears in the document. */ + /** + * @nullable + * @description Address as it appears in the document. + */ address?: components["schemas"]["address"] | null; - /** @description Date of birth as it appears in the document. */ + /** + * @nullable + * @description Date of birth as it appears in the document. + */ dob?: components["schemas"]["gelato_data_document_report_date_of_birth"] | null; - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_document_report_error"] | null; - /** @description Expiration date of the document. */ + /** + * @nullable + * @description Expiration date of the document. + */ expiration_date?: components["schemas"]["gelato_data_document_report_expiration_date"] | null; - /** @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. */ + /** + * @nullable + * @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. + */ files?: string[] | null; - /** @description First name as it appears in the document. */ + /** + * @nullable + * @description First name as it appears in the document. + */ first_name?: string | null; - /** @description Issued date of the document. */ + /** + * @nullable + * @description Issued date of the document. + */ issued_date?: components["schemas"]["gelato_data_document_report_issued_date"] | null; - /** @description Issuing country of the document. */ + /** + * @nullable + * @description Issuing country of the document. + */ issuing_country?: string | null; - /** @description Last name as it appears in the document. */ + /** + * @nullable + * @description Last name as it appears in the document. + */ last_name?: string | null; - /** @description Document ID number. */ + /** + * @nullable + * @description Document ID number. + */ number?: string | null; /** * @description Status of this `document` check. @@ -14824,6 +16148,7 @@ export interface components { */ status: "unverified" | "verified"; /** + * @nullable * @description Type of the document. * @enum {string|null} */ @@ -14832,11 +16157,15 @@ export interface components { /** GelatoDocumentReportError */ gelato_document_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "document_expired" | "document_type_not_supported" | "document_unverified_other" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** @@ -14844,9 +16173,15 @@ export interface components { * @description Result from a email check */ gelato_email_report: { - /** @description Email to be verified. */ + /** + * @nullable + * @description Email to be verified. + */ email?: string | null; - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_email_report_error"] | null; /** * @description Status of this `email` check. @@ -14857,11 +16192,15 @@ export interface components { /** GelatoEmailReportError */ gelato_email_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "email_unverified_other" | "email_verification_declined" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** @@ -14869,20 +16208,36 @@ export interface components { * @description Result from an id_number check */ gelato_id_number_report: { - /** @description Date of birth. */ + /** + * @nullable + * @description Date of birth. + */ dob?: components["schemas"]["gelato_data_id_number_report_date"] | null; - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_id_number_report_error"] | null; - /** @description First name. */ + /** + * @nullable + * @description First name. + */ first_name?: string | null; - /** @description ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present. */ + /** + * @nullable + * @description ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present. + */ id_number?: string | null; /** + * @nullable * @description Type of ID number. * @enum {string|null} */ id_number_type?: "br_cpf" | "sg_nric" | "us_ssn" | null; - /** @description Last name. */ + /** + * @nullable + * @description Last name. + */ last_name?: string | null; /** * @description Status of this `id_number` check. @@ -14893,11 +16248,15 @@ export interface components { /** GelatoIdNumberReportError */ gelato_id_number_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** @@ -14905,9 +16264,15 @@ export interface components { * @description Result from a phone check */ gelato_phone_report: { - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_phone_report_error"] | null; - /** @description Phone to be verified. */ + /** + * @nullable + * @description Phone to be verified. + */ phone?: string | null; /** * @description Status of this `phone` check. @@ -14918,11 +16283,15 @@ export interface components { /** GelatoPhoneReportError */ gelato_phone_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "phone_unverified_other" | "phone_verification_declined" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** GelatoProvidedDetails */ @@ -14950,11 +16319,20 @@ export interface components { * @description Result from a selfie check */ gelato_selfie_report: { - /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. */ + /** + * @nullable + * @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. + */ document?: string | null; - /** @description Details on the verification error. Present when status is `unverified`. */ + /** + * @nullable + * @description Details on the verification error. Present when status is `unverified`. + */ error?: components["schemas"]["gelato_selfie_report_error"] | null; - /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. */ + /** + * @nullable + * @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. + */ selfie?: string | null; /** * @description Status of this `selfie` check. @@ -14965,11 +16343,15 @@ export interface components { /** GelatoSelfieReportError */ gelato_selfie_report_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ code?: "selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other" | null; - /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /** + * @nullable + * @description A human-readable message giving the reason for the failure. These messages can be shown to your users. + */ reason?: string | null; }; /** GelatoSessionDocumentOptions */ @@ -14996,11 +16378,15 @@ export interface components { */ gelato_session_last_error: { /** + * @nullable * @description A short machine-readable string giving the reason for the verification or user-session failure. * @enum {string|null} */ code?: "abandoned" | "consent_declined" | "country_not_supported" | "device_not_supported" | "document_expired" | "document_type_not_supported" | "document_unverified_other" | "email_unverified_other" | "email_verification_declined" | "id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other" | "phone_unverified_other" | "phone_verification_declined" | "selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other" | "under_supported_age" | null; - /** @description A message that explains the reason for verification or user-session failure. */ + /** + * @nullable + * @description A message that explains the reason for verification or user-session failure. + */ reason?: string | null; }; /** GelatoSessionPhoneOptions */ @@ -15022,24 +16408,46 @@ export interface components { }; /** GelatoVerifiedOutputs */ gelato_verified_outputs: { - /** @description The user's verified address. */ + /** + * @nullable + * @description The user's verified address. + */ address?: components["schemas"]["address"] | null; - /** @description The user’s verified date of birth. */ + /** + * @nullable + * @description The user’s verified date of birth. + */ dob?: components["schemas"]["gelato_data_verified_outputs_date"] | null; - /** @description The user's verified email address */ + /** + * @nullable + * @description The user's verified email address + */ email?: string | null; - /** @description The user's verified first name. */ + /** + * @nullable + * @description The user's verified first name. + */ first_name?: string | null; - /** @description The user's verified id number. */ + /** + * @nullable + * @description The user's verified id number. + */ id_number?: string | null; /** + * @nullable * @description The user's verified id number type. * @enum {string|null} */ id_number_type?: "br_cpf" | "sg_nric" | "us_ssn" | null; - /** @description The user's verified last name. */ + /** + * @nullable + * @description The user's verified last name. + */ last_name?: string | null; - /** @description The user's verified phone number */ + /** + * @nullable + * @description The user's verified phone number + */ phone?: string | null; }; /** @@ -15057,11 +16465,14 @@ export interface components { * Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). */ "identity.verification_report": { - /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + /** + * @nullable + * @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. + */ client_reference_id?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; document?: components["schemas"]["gelato_document_report"]; @@ -15086,7 +16497,10 @@ export interface components { type: "document" | "id_number" | "verification_flow"; /** @description The configuration token of a verification flow from the dashboard. */ verification_flow?: string; - /** @description ID of the VerificationSession that created this report. */ + /** + * @nullable + * @description ID of the VerificationSession that created this report. + */ verification_session?: string | null; }; /** @@ -15104,20 +16518,32 @@ export interface components { * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) */ "identity.verification_session": { - /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + /** + * @nullable + * @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. + */ client_reference_id?: string | null; - /** @description The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. */ + /** + * @nullable + * @description The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. + */ client_secret?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; - /** @description If present, this property tells you the last error encountered when processing the verification. */ + /** + * @nullable + * @description If present, this property tells you the last error encountered when processing the verification. + */ last_error?: components["schemas"]["gelato_session_last_error"] | null; - /** @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) */ + /** + * @nullable + * @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) + */ last_verification_report?: (string | components["schemas"]["identity.verification_report"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -15130,13 +16556,25 @@ export interface components { * @enum {string} */ object: "identity.verification_session"; - /** @description A set of options for the session’s verification checks. */ + /** + * @nullable + * @description A set of options for the session’s verification checks. + */ options?: components["schemas"]["gelato_verification_session_options"] | null; - /** @description Details provided about the user being verified. These details may be shown to the user. */ + /** + * @nullable + * @description Details provided about the user being verified. These details may be shown to the user. + */ provided_details?: components["schemas"]["gelato_provided_details"] | null; - /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ + /** + * @nullable + * @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. + */ redaction?: components["schemas"]["verification_session_redaction"] | null; - /** @description Token referencing a Customer resource. */ + /** + * @nullable + * @description Token referencing a Customer resource. + */ related_customer?: string | null; /** * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). @@ -15148,11 +16586,17 @@ export interface components { * @enum {string} */ type: "document" | "id_number" | "verification_flow"; - /** @description The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. */ + /** + * @nullable + * @description The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. + */ url?: string | null; /** @description The configuration token of a verification flow from the dashboard. */ verification_flow?: string; - /** @description The user’s verified data. */ + /** + * @nullable + * @description The user’s verified data. + */ verified_outputs?: components["schemas"]["gelato_verified_outputs"] | null; }; /** InboundTransfers */ @@ -15168,20 +16612,31 @@ export interface components { /** inbound_transfers_payment_method_details_us_bank_account */ inbound_transfers_payment_method_details_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; @@ -15190,20 +16645,38 @@ export interface components { * @enum {string} */ network: "ach"; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; }; /** internal_card */ internal_card: { - /** @description Brand of the card used in the transaction */ + /** + * @nullable + * @description Brand of the card used in the transaction + */ brand?: string | null; - /** @description Two-letter ISO code representing the country of the card */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card + */ country?: string | null; - /** @description Two digit number representing the card's expiration month */ + /** + * @nullable + * @description Two digit number representing the card's expiration month + */ exp_month?: number | null; - /** @description Two digit number representing the card's expiration year */ + /** + * @nullable + * @description Two digit number representing the card's expiration year + */ exp_year?: number | null; - /** @description The last 4 digits of the card */ + /** + * @nullable + * @description The last 4 digits of the card + */ last4?: string | null; }; /** @@ -15242,11 +16715,20 @@ export interface components { * Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending) */ invoice: { - /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ + /** + * @nullable + * @description The country of the business associated with this invoice, most often the business creating the invoice. + */ account_country?: string | null; - /** @description The public name of the business associated with this invoice, most often the business creating the invoice. */ + /** + * @nullable + * @description The public name of the business associated with this invoice, most often the business creating the invoice. + */ account_name?: string | null; - /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ + /** + * @nullable + * @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; /** @description Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. */ amount_due: number; @@ -15256,9 +16738,15 @@ export interface components { amount_remaining: number; /** @description This is the sum of all the shipping amounts. */ amount_shipping: number; - /** @description ID of the Connect Application that created the invoice. */ + /** + * @nullable + * @description ID of the Connect Application that created the invoice. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ + /** + * @nullable + * @description The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. + */ application_fee_amount?: number | null; /** @description Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained. */ attempt_count: number; @@ -15268,11 +16756,13 @@ export interface components { auto_advance?: boolean; automatic_tax: components["schemas"]["automatic_tax"]; /** - * Format: unix-time + * @nullable * @description The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized. + * @format unix-time */ automatically_finalizes_at?: number | null; /** + * @nullable * @description Indicates the reason why the invoice was created. * * * `manual`: Unrelated to a subscription, for example, created via the invoice editor. @@ -15285,7 +16775,10 @@ export interface components { * @enum {string|null} */ billing_reason?: "automatic_pending_invoice_item_invoice" | "manual" | "quote_accept" | "subscription" | "subscription_create" | "subscription_cycle" | "subscription_threshold" | "subscription_update" | "upcoming" | null; - /** @description ID of the latest charge generated for this invoice, if any. */ + /** + * @nullable + * @description ID of the latest charge generated for this invoice, if any. + */ charge?: (string | components["schemas"]["charge"]) | null; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. @@ -15293,74 +16786,134 @@ export interface components { */ collection_method: "charge_automatically" | "send_invoice"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description Custom fields displayed on the invoice. */ + /** + * @nullable + * @description Custom fields displayed on the invoice. + */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; - /** @description The ID of the customer who will be billed. */ + /** + * @nullable + * @description The ID of the customer who will be billed. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated. + */ customer_address?: components["schemas"]["address"] | null; - /** @description The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. + */ customer_email?: string | null; - /** @description The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated. + */ customer_name?: string | null; - /** @description The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated. + */ customer_phone?: string | null; - /** @description The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated. + */ customer_shipping?: components["schemas"]["shipping"] | null; /** + * @nullable * @description The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated. * @enum {string|null} */ customer_tax_exempt?: "exempt" | "none" | "reverse" | null; - /** @description The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated. */ + /** + * @nullable + * @description The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated. + */ customer_tax_ids?: components["schemas"]["invoices_resource_invoice_tax_id"][] | null; - /** @description ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. */ + /** + * @nullable + * @description ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. + */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. */ + /** + * @nullable + * @description ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. + */ default_source?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]) | null; /** @description The tax rates applied to this invoice, if any. */ default_tax_rates: components["schemas"]["tax_rate"][]; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. + */ description?: string | null; - /** @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ + /** + * @nullable + * @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. + */ discount?: components["schemas"]["discount"] | null; /** @description The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ discounts: (string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"])[]; /** - * Format: unix-time + * @nullable * @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. + * @format unix-time */ due_date?: number | null; /** - * Format: unix-time + * @nullable * @description The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. + * @format unix-time */ effective_at?: number | null; - /** @description Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. */ + /** + * @nullable + * @description Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. + */ ending_balance?: number | null; - /** @description Footer displayed on the invoice. */ + /** + * @nullable + * @description Footer displayed on the invoice. + */ footer?: string | null; - /** @description Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. */ + /** + * @nullable + * @description Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. + */ from_invoice?: components["schemas"]["invoices_resource_from_invoice"] | null; - /** @description The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. */ + /** + * @nullable + * @description The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. + */ hosted_invoice_url?: string | null; /** @description Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details. */ id?: string; - /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ + /** + * @nullable + * @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. + */ invoice_pdf?: string | null; issuer: components["schemas"]["connect_account_reference"]; - /** @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. */ + /** + * @nullable + * @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. + */ last_finalization_error?: components["schemas"]["api_errors"] | null; - /** @description The ID of the most recent non-draft revision of this invoice */ + /** + * @nullable + * @description The ID of the most recent non-draft revision of this invoice + */ latest_revision?: (string | components["schemas"]["invoice"]) | null; /** * InvoiceLinesList @@ -15381,101 +16934,164 @@ export interface components { }; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; /** - * Format: unix-time + * @nullable * @description The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. + * @format unix-time */ next_payment_attempt?: number | null; - /** @description A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. */ + /** + * @nullable + * @description A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. + */ number?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "invoice"; - /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + /** + * @nullable + * @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** @description Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance. */ paid: boolean; /** @description Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. */ paid_out_of_band: boolean; - /** @description The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent. */ + /** + * @nullable + * @description The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; payment_settings: components["schemas"]["invoices_payment_settings"]; /** - * Format: unix-time * @description End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. + * @format unix-time */ period_end: number; /** - * Format: unix-time * @description Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. + * @format unix-time */ period_start: number; /** @description Total amount of all post-payment credit notes issued for this invoice. */ post_payment_credit_notes_amount: number; /** @description Total amount of all pre-payment credit notes issued for this invoice. */ pre_payment_credit_notes_amount: number; - /** @description The quote this invoice was generated from. */ + /** + * @nullable + * @description The quote this invoice was generated from. + */ quote?: (string | components["schemas"]["quote"]) | null; - /** @description This is the transaction number that appears on email receipts sent for this invoice. */ + /** + * @nullable + * @description This is the transaction number that appears on email receipts sent for this invoice. + */ receipt_number?: string | null; - /** @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. */ + /** + * @nullable + * @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. + */ rendering?: components["schemas"]["invoices_resource_invoice_rendering"] | null; - /** @description The details of the cost of shipping, including the ShippingRate applied on the invoice. */ + /** + * @nullable + * @description The details of the cost of shipping, including the ShippingRate applied on the invoice. + */ shipping_cost?: components["schemas"]["invoices_resource_shipping_cost"] | null; - /** @description Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. */ + /** + * @nullable + * @description Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. + */ shipping_details?: components["schemas"]["shipping"] | null; /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice. */ starting_balance: number; - /** @description Extra information about an invoice for the customer's credit card statement. */ + /** + * @nullable + * @description Extra information about an invoice for the customer's credit card statement. + */ statement_descriptor?: string | null; /** + * @nullable * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) * @enum {string|null} */ status?: "draft" | "open" | "paid" | "uncollectible" | "void" | null; status_transitions: components["schemas"]["invoices_resource_status_transitions"]; - /** @description The subscription that this invoice was prepared for, if any. */ + /** + * @nullable + * @description The subscription that this invoice was prepared for, if any. + */ subscription?: (string | components["schemas"]["subscription"]) | null; - /** @description Details about the subscription that created this invoice. */ + /** + * @nullable + * @description Details about the subscription that created this invoice. + */ subscription_details?: components["schemas"]["subscription_details_data"] | null; /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ subscription_proration_date?: number; /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated */ subtotal: number; - /** @description The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated + */ subtotal_excluding_tax?: number | null; - /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ + /** + * @nullable + * @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. + */ tax?: number | null; - /** @description ID of the test clock this invoice belongs to. */ + /** + * @nullable + * @description ID of the test clock this invoice belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; threshold_reason?: components["schemas"]["invoice_threshold_reason"]; /** @description Total after discounts and taxes. */ total: number; - /** @description The aggregate amounts calculated per discount across all line items. */ + /** + * @nullable + * @description The aggregate amounts calculated per discount across all line items. + */ total_discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; - /** @description The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. + */ total_excluding_tax?: number | null; - /** @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. */ + /** + * @nullable + * @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. + */ total_pretax_credit_amounts?: components["schemas"]["invoices_resource_pretax_credit_amount"][] | null; /** @description The aggregate amounts calculated per tax rate for all line items. */ total_tax_amounts: components["schemas"]["invoice_tax_amount"][]; - /** @description The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. */ + /** + * @nullable + * @description The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. + */ transfer_data?: components["schemas"]["invoice_transfer_data"] | null; /** - * Format: unix-time + * @nullable * @description Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. + * @format unix-time */ webhooks_delivered_at?: number | null; }; /** invoice_installments_card */ invoice_installments_card: { - /** @description Whether Installments are enabled for this Invoice. */ + /** + * @nullable + * @description Whether Installments are enabled for this Invoice. + */ enabled?: boolean | null; }; /** InvoiceItemThresholdReason */ @@ -15488,26 +17104,33 @@ export interface components { /** InvoiceLineItemPeriod */ invoice_line_item_period: { /** - * Format: unix-time * @description The end of the period, which must be greater than or equal to the start. This value is inclusive. + * @format unix-time */ end: number; /** - * Format: unix-time * @description The start of the period. This value is inclusive. + * @format unix-time */ start: number; }; /** invoice_mandate_options_card */ invoice_mandate_options_card: { - /** @description Amount to be charged for future payments. */ + /** + * @nullable + * @description Amount to be charged for future payments. + */ amount?: number | null; /** + * @nullable * @description One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. * @enum {string|null} */ amount_type?: "fixed" | "maximum" | null; - /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ + /** + * @nullable + * @description A description of the mandate or subscription that is meant to be displayed to the customer. + */ description?: string | null; }; /** invoice_payment_method_options_acss_debit */ @@ -15522,6 +17145,7 @@ export interface components { /** invoice_payment_method_options_acss_debit_mandate_options */ invoice_payment_method_options_acss_debit_mandate_options: { /** + * @nullable * @description Transaction type of the mandate. * @enum {string|null} */ @@ -15539,6 +17163,7 @@ export interface components { invoice_payment_method_options_card: { installments?: components["schemas"]["invoice_installments_card"]; /** + * @nullable * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ @@ -15548,6 +17173,7 @@ export interface components { invoice_payment_method_options_customer_balance: { bank_transfer?: components["schemas"]["invoice_payment_method_options_customer_balance_bank_transfer"]; /** + * @nullable * @description The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. * @enum {string|null} */ @@ -15556,7 +17182,10 @@ export interface components { /** invoice_payment_method_options_customer_balance_bank_transfer */ invoice_payment_method_options_customer_balance_bank_transfer: { eu_bank_transfer?: components["schemas"]["invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer"]; - /** @description The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. */ + /** + * @nullable + * @description The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. + */ type?: string | null; }; /** invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer */ @@ -15585,7 +17214,10 @@ export interface components { filters?: components["schemas"]["invoice_payment_method_options_us_bank_account_linked_account_options_filters"]; /** @description The list of permissions to request. The `payment_method` permission must be included. */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - /** @description Data features requested to be retrieved upon account creation. */ + /** + * @nullable + * @description Data features requested to be retrieved upon account creation. + */ prefetch?: ("balances" | "ownership" | "transactions")[] | null; }; /** invoice_payment_method_options_us_bank_account_linked_account_options_filters */ @@ -15596,6 +17228,7 @@ export interface components { /** InvoiceRenderingPdf */ invoice_rendering_pdf: { /** + * @nullable * @description Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale. * @enum {string|null} */ @@ -15608,19 +17241,25 @@ export interface components { */ invoice_rendering_template: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description A brief description of the template, hidden from customers */ + /** + * @nullable + * @description A brief description of the template, hidden from customers + */ nickname?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -15644,47 +17283,86 @@ export interface components { }; /** InvoiceSettingCustomerRenderingOptions */ invoice_setting_customer_rendering_options: { - /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + /** + * @nullable + * @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. + */ amount_tax_display?: string | null; - /** @description ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. */ + /** + * @nullable + * @description ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. + */ template?: string | null; }; /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { - /** @description Default custom fields to be displayed on invoices for this customer. */ + /** + * @nullable + * @description Default custom fields to be displayed on invoices for this customer. + */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; - /** @description ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. */ + /** + * @nullable + * @description ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. + */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description Default footer to be displayed on invoices for this customer. */ + /** + * @nullable + * @description Default footer to be displayed on invoices for this customer. + */ footer?: string | null; - /** @description Default options for invoice PDF rendering for this customer. */ + /** + * @nullable + * @description Default options for invoice PDF rendering for this customer. + */ rendering_options?: components["schemas"]["invoice_setting_customer_rendering_options"] | null; }; /** InvoiceSettingQuoteSetting */ invoice_setting_quote_setting: { - /** @description Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. */ + /** + * @nullable + * @description Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. + */ days_until_due?: number | null; issuer: components["schemas"]["connect_account_reference"]; }; /** InvoiceSettingRenderingOptions */ invoice_setting_rendering_options: { - /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + /** + * @nullable + * @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. + */ amount_tax_display?: string | null; }; /** InvoiceSettingSubscriptionSchedulePhaseSetting */ invoice_setting_subscription_schedule_phase_setting: { - /** @description The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. */ + /** + * @nullable + * @description The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; - /** @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. */ + /** + * @nullable + * @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. + */ days_until_due?: number | null; - /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + /** + * @nullable + * @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. + */ issuer?: components["schemas"]["connect_account_reference"] | null; }; /** InvoiceSettingSubscriptionScheduleSetting */ invoice_setting_subscription_schedule_setting: { - /** @description The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. */ + /** + * @nullable + * @description The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; - /** @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. */ + /** + * @nullable + * @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. + */ days_until_due?: number | null; issuer: components["schemas"]["connect_account_reference"]; }; @@ -15697,23 +17375,33 @@ export interface components { /** @description The tax rate that was applied to get this tax amount. */ tax_rate: string | components["schemas"]["tax_rate"]; /** + * @nullable * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. * @enum {string|null} */ taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in cents (or local equivalent). */ + /** + * @nullable + * @description The amount on which tax is calculated, in cents (or local equivalent). + */ taxable_amount?: number | null; }; /** InvoiceThresholdReason */ invoice_threshold_reason: { - /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ + /** + * @nullable + * @description The total invoice amount threshold boundary if it triggered the threshold invoice. + */ amount_gte?: number | null; /** @description Indicates which line items triggered a threshold invoice. */ item_reasons: components["schemas"]["invoice_item_threshold_reason"][]; }; /** InvoiceTransferData */ invoice_transfer_data: { - /** @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ + /** + * @nullable + * @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. + */ amount?: number | null; /** @description The account where funds from the payment will be transferred to upon payment success. */ destination: string | components["schemas"]["account"]; @@ -15736,30 +17424,42 @@ export interface components { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The ID of the customer who will be billed when this invoice item is billed. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ date: number; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description If true, discounts will apply to this invoice item. Always false for prorations. */ discountable: boolean; - /** @description The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ + /** + * @nullable + * @description The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. + */ discounts?: (string | components["schemas"]["discount"])[] | null; /** @description Unique identifier for the object. */ id: string; - /** @description The ID of the invoice this invoice item belongs to. */ + /** + * @nullable + * @description The ID of the invoice this invoice item belongs to. + */ invoice?: (string | components["schemas"]["invoice"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -15769,52 +17469,98 @@ export interface components { */ object: "invoiceitem"; period: components["schemas"]["invoice_line_item_period"]; - /** @description The price of the invoice item. */ + /** + * @nullable + * @description The price of the invoice item. + */ price?: components["schemas"]["price"] | null; /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ proration: boolean; /** @description Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for. */ quantity: number; - /** @description The subscription that this invoice item has been created for, if any. */ + /** + * @nullable + * @description The subscription that this invoice item has been created for, if any. + */ subscription?: (string | components["schemas"]["subscription"]) | null; /** @description The subscription item that this invoice item has been created for, if any. */ subscription_item?: string; - /** @description The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. */ + /** + * @nullable + * @description The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. + */ tax_rates?: components["schemas"]["tax_rate"][] | null; - /** @description ID of the test clock this invoice item belongs to. */ + /** + * @nullable + * @description ID of the test clock this invoice item belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; - /** @description Unit amount (in the `currency` specified) of the invoice item. */ + /** + * @nullable + * @description Unit amount (in the `currency` specified) of the invoice item. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ unit_amount_decimal?: string | null; }; /** InvoicesPaymentMethodOptions */ invoices_payment_method_options: { - /** @description If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent. + */ acss_debit?: components["schemas"]["invoice_payment_method_options_acss_debit"] | null; - /** @description If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. + */ bancontact?: components["schemas"]["invoice_payment_method_options_bancontact"] | null; - /** @description If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. + */ card?: components["schemas"]["invoice_payment_method_options_card"] | null; - /** @description If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent. + */ customer_balance?: components["schemas"]["invoice_payment_method_options_customer_balance"] | null; - /** @description If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent. + */ konbini?: components["schemas"]["invoice_payment_method_options_konbini"] | null; - /** @description If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent. + */ sepa_debit?: components["schemas"]["invoice_payment_method_options_sepa_debit"] | null; - /** @description If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent. + */ us_bank_account?: components["schemas"]["invoice_payment_method_options_us_bank_account"] | null; }; /** InvoicesPaymentSettings */ invoices_payment_settings: { - /** @description ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. */ + /** + * @nullable + * @description ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. + */ default_mandate?: string | null; - /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ + /** + * @nullable + * @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. + */ payment_method_options?: components["schemas"]["invoices_payment_method_options"] | null; - /** @description The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ + /** + * @nullable + * @description The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). + */ payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; }; /** InvoicesResourceFromInvoice */ @@ -15826,13 +17572,25 @@ export interface components { }; /** InvoicesResourceInvoiceRendering */ invoices_resource_invoice_rendering: { - /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + /** + * @nullable + * @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. + */ amount_tax_display?: string | null; - /** @description Invoice pdf rendering options */ + /** + * @nullable + * @description Invoice pdf rendering options + */ pdf?: components["schemas"]["invoice_rendering_pdf"] | null; - /** @description ID of the rendering template that the invoice is formatted by. */ + /** + * @nullable + * @description ID of the rendering template that the invoice is formatted by. + */ template?: string | null; - /** @description Version of the rendering template that the invoice is using. */ + /** + * @nullable + * @description Version of the rendering template that the invoice is using. + */ template_version?: number | null; }; /** InvoicesResourceInvoiceTaxID */ @@ -15842,7 +17600,10 @@ export interface components { * @enum {string} */ type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; - /** @description The value of the tax ID. */ + /** + * @nullable + * @description The value of the tax ID. + */ value?: string | null; }; /** InvoicesResourceLineItemsCreditedItems */ @@ -15854,14 +17615,20 @@ export interface components { }; /** InvoicesResourceLineItemsProrationDetails */ invoices_resource_line_items_proration_details: { - /** @description For a credit proration `line_item`, the original debit line_items to which the credit proration applies. */ + /** + * @nullable + * @description For a credit proration `line_item`, the original debit line_items to which the credit proration applies. + */ credited_items?: components["schemas"]["invoices_resource_line_items_credited_items"] | null; }; /** InvoicesResourcePretaxCreditAmount */ invoices_resource_pretax_credit_amount: { /** @description The amount, in cents (or local equivalent), of the pretax credit amount. */ amount: number; - /** @description The credit balance transaction that was applied to get this pretax credit amount. */ + /** + * @nullable + * @description The credit balance transaction that was applied to get this pretax credit amount. + */ credit_balance_transaction?: (string | components["schemas"]["billing.credit_balance_transaction"]) | null; /** @description The discount that was applied to get this pretax credit amount. */ discount?: string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"]; @@ -15879,7 +17646,10 @@ export interface components { amount_tax: number; /** @description Total shipping cost after taxes are applied. */ amount_total: number; - /** @description The ID of the ShippingRate for this invoice. */ + /** + * @nullable + * @description The ID of the ShippingRate for this invoice. + */ shipping_rate?: (string | components["schemas"]["shipping_rate"]) | null; /** @description The taxes applied to the shipping rate. */ taxes?: components["schemas"]["line_items_tax_amount"][]; @@ -15887,23 +17657,27 @@ export interface components { /** InvoicesResourceStatusTransitions */ invoices_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description The time that the invoice draft was finalized. + * @format unix-time */ finalized_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the invoice was marked uncollectible. + * @format unix-time */ marked_uncollectible_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the invoice was paid. + * @format unix-time */ paid_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the invoice was voided. + * @format unix-time */ voided_at?: number | null; }; @@ -15918,7 +17692,10 @@ export interface components { "issuing.authorization": { /** @description The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different. */ amount: number; - /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** + * @nullable + * @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; /** @description Whether the authorization has been approved. */ approved: boolean; @@ -15930,23 +17707,35 @@ export interface components { /** @description List of balance transactions associated with this authorization. */ balance_transactions: components["schemas"]["balance_transaction"][]; card: components["schemas"]["issuing.card"]; - /** @description The cardholder to whom this authorization belongs. */ + /** + * @nullable + * @description The cardholder to whom this authorization belongs. + */ cardholder?: (string | components["schemas"]["issuing.cardholder"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description Fleet-specific information for authorizations using Fleet cards. */ + /** + * @nullable + * @description Fleet-specific information for authorizations using Fleet cards. + */ fleet?: components["schemas"]["issuing_authorization_fleet_data"] | null; - /** @description Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. */ + /** + * @nullable + * @description Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. + */ fraud_challenges?: components["schemas"]["issuing_authorization_fraud_challenge"][] | null; - /** @description Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. */ + /** + * @nullable + * @description Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. + */ fuel?: components["schemas"]["issuing_authorization_fuel_data"] | null; /** @description Unique identifier for the object. */ id: string; @@ -15955,8 +17744,8 @@ export interface components { /** @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; /** - * Format: currency * @description The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; @@ -15964,14 +17753,20 @@ export interface components { metadata: { [key: string]: string; }; - /** @description Details about the authorization, such as identifiers, set by the card network. */ + /** + * @nullable + * @description Details about the authorization, such as identifiers, set by the card network. + */ network_data?: components["schemas"]["issuing_authorization_network_data"] | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "issuing.authorization"; - /** @description The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. */ + /** + * @nullable + * @description The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. + */ pending_request?: components["schemas"]["issuing_authorization_pending_request"] | null; /** @description History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. */ request_history: components["schemas"]["issuing_authorization_request"][]; @@ -15980,16 +17775,28 @@ export interface components { * @enum {string} */ status: "closed" | "pending" | "reversed"; - /** @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. */ + /** + * @nullable + * @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. + */ token?: (string | components["schemas"]["issuing.token"]) | null; /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ transactions: components["schemas"]["issuing.transaction"][]; - /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). */ + /** + * @nullable + * @description [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). + */ treasury?: components["schemas"]["issuing_authorization_treasury"] | null; verification_data: components["schemas"]["issuing_authorization_verification_data"]; - /** @description Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. */ + /** + * @nullable + * @description Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. + */ verified_by_fraud_challenge?: boolean | null; - /** @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. */ + /** + * @nullable + * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. + */ wallet?: string | null; }; /** @@ -16000,19 +17807,20 @@ export interface components { /** @description The brand of the card. */ brand: string; /** + * @nullable * @description The reason why the card was canceled. * @enum {string|null} */ cancellation_reason?: "design_rejected" | "lost" | "stolen" | null; cardholder: components["schemas"]["issuing.cardholder"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. + * @format currency */ currency: string; /** @description The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ @@ -16021,7 +17829,10 @@ export interface components { exp_month: number; /** @description The expiration year of the card. */ exp_year: number; - /** @description The financial account this card is attached to. */ + /** + * @nullable + * @description The financial account this card is attached to. + */ financial_account?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -16040,18 +17851,31 @@ export interface components { * @enum {string} */ object: "issuing.card"; - /** @description The personalization design object belonging to this card. */ + /** + * @nullable + * @description The personalization design object belonging to this card. + */ personalization_design?: (string | components["schemas"]["issuing.personalization_design"]) | null; - /** @description The latest card that replaces this card, if any. */ + /** + * @nullable + * @description The latest card that replaces this card, if any. + */ replaced_by?: (string | components["schemas"]["issuing.card"]) | null; - /** @description The card this card replaces, if any. */ + /** + * @nullable + * @description The card this card replaces, if any. + */ replacement_for?: (string | components["schemas"]["issuing.card"]) | null; /** + * @nullable * @description The reason why the previous card needed to be replaced. * @enum {string|null} */ replacement_reason?: "damaged" | "expired" | "lost" | "stolen" | null; - /** @description Where and how the card will be shipped. */ + /** + * @nullable + * @description Where and how the card will be shipped. + */ shipping?: components["schemas"]["issuing_card_shipping"] | null; spending_controls: components["schemas"]["issuing_card_authorization_controls"]; /** @@ -16064,7 +17888,10 @@ export interface components { * @enum {string} */ type: "physical" | "virtual"; - /** @description Information relating to digital wallets (like Apple Pay and Google Pay). */ + /** + * @nullable + * @description Information relating to digital wallets (like Apple Pay and Google Pay). + */ wallets?: components["schemas"]["issuing_card_wallets"] | null; }; /** @@ -16075,18 +17902,27 @@ export interface components { */ "issuing.cardholder": { billing: components["schemas"]["issuing_cardholder_address"]; - /** @description Additional information about a `company` cardholder. */ + /** + * @nullable + * @description Additional information about a `company` cardholder. + */ company?: components["schemas"]["issuing_cardholder_company"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The cardholder's email address. */ + /** + * @nullable + * @description The cardholder's email address. + */ email?: string | null; /** @description Unique identifier for the object. */ id: string; - /** @description Additional information about an `individual` cardholder. */ + /** + * @nullable + * @description Additional information about an `individual` cardholder. + */ individual?: components["schemas"]["issuing_cardholder_individual"] | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -16101,15 +17937,22 @@ export interface components { * @enum {string} */ object: "issuing.cardholder"; - /** @description The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. */ + /** + * @nullable + * @description The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. + */ phone_number?: string | null; /** + * @nullable * @description The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. * This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. */ preferred_locales?: ("de" | "en" | "es" | "fr" | "it")[] | null; requirements: components["schemas"]["issuing_cardholder_requirements"]; - /** @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ + /** + * @nullable + * @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + */ spending_controls?: components["schemas"]["issuing_cardholder_authorization_controls"] | null; /** * @description Specifies whether to permit authorizations on this cardholder's cards. @@ -16131,16 +17974,19 @@ export interface components { "issuing.dispute": { /** @description Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ amount: number; - /** @description List of balance transactions associated with the dispute. */ + /** + * @nullable + * @description List of balance transactions associated with the dispute. + */ balance_transactions?: components["schemas"]["balance_transaction"][] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description The currency the `transaction` was made in. + * @format currency */ currency: string; evidence: components["schemas"]["issuing_dispute_evidence"]; @@ -16169,7 +18015,10 @@ export interface components { status: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; /** @description The transaction being disputed. */ transaction: string | components["schemas"]["issuing.transaction"]; - /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ + /** + * @nullable + * @description [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts + */ treasury?: components["schemas"]["issuing_dispute_treasury"] | null; }; /** @@ -16177,26 +18026,38 @@ export interface components { * @description A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line. */ "issuing.personalization_design": { - /** @description The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. */ + /** + * @nullable + * @description The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. + */ card_logo?: (string | components["schemas"]["file"]) | null; - /** @description Hash containing carrier text, for use with physical bundles that support carrier text. */ + /** + * @nullable + * @description Hash containing carrier text, for use with physical bundles that support carrier text. + */ carrier_text?: components["schemas"]["issuing_personalization_design_carrier_text"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. */ + /** + * @nullable + * @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. + */ lookup_key?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { [key: string]: string; }; - /** @description Friendly display name. */ + /** + * @nullable + * @description Friendly display name. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -16249,18 +18110,18 @@ export interface components { /** @description The Bank Identification Number reflecting this settlement record. */ bin: string; /** - * Format: unix-time * @description The date that the transactions are cleared and posted to user's accounts. + * @format unix-time */ clearing_date: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Unique identifier for the object. */ @@ -16309,11 +18170,14 @@ export interface components { /** @description Card associated with this token. */ card: string | components["schemas"]["issuing.card"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The hashed ID derived from the device ID from the card network associated with the token. */ + /** + * @nullable + * @description The hashed ID derived from the device ID from the card network associated with the token. + */ device_fingerprint?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -16328,8 +18192,8 @@ export interface components { network: "mastercard" | "visa"; network_data?: components["schemas"]["issuing_network_token_network_data"]; /** - * Format: unix-time * @description Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch. + * @format unix-time */ network_updated_at: number; /** @@ -16359,27 +18223,42 @@ export interface components { "issuing.transaction": { /** @description The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ 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). */ + /** + * @nullable + * @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_transaction_amount_details"] | null; - /** @description The `Authorization` object that led to this transaction. */ + /** + * @nullable + * @description The `Authorization` object that led to this transaction. + */ authorization?: (string | components["schemas"]["issuing.authorization"]) | null; - /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ + /** + * @nullable + * @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** @description The card used to make this transaction. */ card: string | components["schemas"]["issuing.card"]; - /** @description The cardholder to whom this transaction belongs. */ + /** + * @nullable + * @description The cardholder to whom this transaction belongs. + */ cardholder?: (string | components["schemas"]["issuing.cardholder"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description If you've disputed the transaction, the ID of the dispute. */ + /** + * @nullable + * @description If you've disputed the transaction, the ID of the dispute. + */ dispute?: (string | components["schemas"]["issuing.dispute"]) | null; /** @description Unique identifier for the object. */ id: string; @@ -16388,8 +18267,8 @@ export interface components { /** @description The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. */ merchant_amount: number; /** - * Format: currency * @description The currency with which the merchant is taking payment. + * @format currency */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; @@ -16397,18 +18276,30 @@ export interface components { metadata: { [key: string]: string; }; - /** @description Details about the transaction, such as processing dates, set by the card network. */ + /** + * @nullable + * @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} */ object: "issuing.transaction"; - /** @description Additional purchase information that is optionally provided by the merchant. */ + /** + * @nullable + * @description Additional purchase information that is optionally provided by the merchant. + */ purchase_details?: components["schemas"]["issuing_transaction_purchase_details"] | null; - /** @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. */ + /** + * @nullable + * @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. + */ token?: (string | components["schemas"]["issuing.token"]) | null; - /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ + /** + * @nullable + * @description [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts + */ treasury?: components["schemas"]["issuing_transaction_treasury"] | null; /** * @description The nature of the transaction. @@ -16416,6 +18307,7 @@ export interface components { */ type: "capture" | "refund"; /** + * @nullable * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. * @enum {string|null} */ @@ -16423,9 +18315,15 @@ export interface components { }; /** IssuingAuthorizationAmountDetails */ issuing_authorization_amount_details: { - /** @description The fee charged by the ATM for the cash withdrawal. */ + /** + * @nullable + * @description The fee charged by the ATM for the cash withdrawal. + */ atm_fee?: number | null; - /** @description The amount of cash requested by the cardholder. */ + /** + * @nullable + * @description The amount of cash requested by the cardholder. + */ cashback_amount?: number | null; }; /** IssuingAuthorizationAuthenticationExemption */ @@ -16443,31 +18341,57 @@ export interface components { }; /** IssuingAuthorizationFleetCardholderPromptData */ issuing_authorization_fleet_cardholder_prompt_data: { - /** @description [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID. */ + /** + * @nullable + * @description [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID. + */ alphanumeric_id?: string | null; - /** @description Driver ID. */ + /** + * @nullable + * @description Driver ID. + */ driver_id?: string | null; - /** @description Odometer reading. */ + /** + * @nullable + * @description Odometer reading. + */ odometer?: number | null; - /** @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. */ + /** + * @nullable + * @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. + */ unspecified_id?: string | null; - /** @description User ID. */ + /** + * @nullable + * @description User ID. + */ user_id?: string | null; - /** @description Vehicle number. */ + /** + * @nullable + * @description Vehicle number. + */ vehicle_number?: string | null; }; /** IssuingAuthorizationFleetData */ issuing_authorization_fleet_data: { - /** @description Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry. */ + /** + * @nullable + * @description Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry. + */ cardholder_prompt_data?: components["schemas"]["issuing_authorization_fleet_cardholder_prompt_data"] | null; /** + * @nullable * @description The type of purchase. * @enum {string|null} */ purchase_type?: "fuel_and_non_fuel_purchase" | "fuel_purchase" | "non_fuel_purchase" | null; - /** @description More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data. */ + /** + * @nullable + * @description More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data. + */ reported_breakdown?: components["schemas"]["issuing_authorization_fleet_reported_breakdown"] | null; /** + * @nullable * @description The type of fuel service. * @enum {string|null} */ @@ -16476,38 +18400,51 @@ export interface components { /** IssuingAuthorizationFleetFuelPriceData */ issuing_authorization_fleet_fuel_price_data: { /** - * Format: decimal + * @nullable * @description Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes. + * @format decimal */ gross_amount_decimal?: string | null; }; /** IssuingAuthorizationFleetNonFuelPriceData */ issuing_authorization_fleet_non_fuel_price_data: { /** - * Format: decimal + * @nullable * @description Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. + * @format decimal */ gross_amount_decimal?: string | null; }; /** IssuingAuthorizationFleetReportedBreakdown */ issuing_authorization_fleet_reported_breakdown: { - /** @description Breakdown of fuel portion of the purchase. */ + /** + * @nullable + * @description Breakdown of fuel portion of the purchase. + */ fuel?: components["schemas"]["issuing_authorization_fleet_fuel_price_data"] | null; - /** @description Breakdown of non-fuel portion of the purchase. */ + /** + * @nullable + * @description Breakdown of non-fuel portion of the purchase. + */ non_fuel?: components["schemas"]["issuing_authorization_fleet_non_fuel_price_data"] | null; - /** @description Information about tax included in this transaction. */ + /** + * @nullable + * @description Information about tax included in this transaction. + */ tax?: components["schemas"]["issuing_authorization_fleet_tax_data"] | null; }; /** IssuingAuthorizationFleetTaxData */ issuing_authorization_fleet_tax_data: { /** - * Format: decimal + * @nullable * @description Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax. + * @format decimal */ local_amount_decimal?: string | null; /** - * Format: decimal + * @nullable * @description Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax. + * @format decimal */ national_amount_decimal?: string | null; }; @@ -16524,6 +18461,7 @@ export interface components { */ status: "expired" | "pending" | "rejected" | "undeliverable" | "verified"; /** + * @nullable * @description If the challenge is not deliverable, the reason why. * @enum {string|null} */ @@ -16531,26 +18469,33 @@ export interface components { }; /** IssuingAuthorizationFuelData */ issuing_authorization_fuel_data: { - /** @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. */ + /** + * @nullable + * @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. + */ industry_product_code?: string | null; /** - * Format: decimal + * @nullable * @description The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. + * @format decimal */ quantity_decimal?: string | null; /** + * @nullable * @description The type of fuel that was purchased. * @enum {string|null} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super" | null; /** + * @nullable * @description The units for `quantity_decimal`. * @enum {string|null} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon" | null; /** - * Format: decimal + * @nullable * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. + * @format decimal */ unit_cost_decimal?: string | null; }; @@ -16560,43 +18505,79 @@ export interface components { category: string; /** @description The merchant category code for the seller’s business */ category_code: string; - /** @description City where the seller is located */ + /** + * @nullable + * @description City where the seller is located + */ city?: string | null; - /** @description Country where the seller is located */ + /** + * @nullable + * @description Country where the seller is located + */ country?: string | null; - /** @description Name of the seller */ + /** + * @nullable + * @description Name of the seller + */ name?: string | null; /** @description Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. */ network_id: string; - /** @description Postal code where the seller is located */ + /** + * @nullable + * @description Postal code where the seller is located + */ postal_code?: string | null; - /** @description State where the seller is located */ + /** + * @nullable + * @description State where the seller is located + */ state?: string | null; - /** @description The seller's tax identification number. Currently populated for French merchants only. */ + /** + * @nullable + * @description The seller's tax identification number. Currently populated for French merchants only. + */ tax_id?: string | null; - /** @description An ID assigned by the seller to the location of the sale. */ + /** + * @nullable + * @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 */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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: { /** @description The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ 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). */ + /** + * @nullable + * @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; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ @@ -16604,26 +18585,35 @@ export interface components { /** @description The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ merchant_amount: number; /** - * Format: currency * @description The local currency the merchant is requesting to authorize. + * @format currency */ merchant_currency: string; - /** @description The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. */ + /** + * @nullable + * @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: { /** @description The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. */ 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). */ + /** + * @nullable + * @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; /** @description Whether this request was approved. */ approved: boolean; - /** @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. */ + /** + * @nullable + * @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; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ 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). */ @@ -16632,18 +18622,25 @@ 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. */ + /** + * @nullable + * @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_canceled" | "card_expired" | "card_inactive" | "cardholder_blocked" | "cardholder_inactive" | "cardholder_verification_required" | "insecure_authorization_method" | "insufficient_funds" | "not_allowed" | "pin_blocked" | "spending_controls" | "suspected_fraud" | "verification_failed" | "webhook_approved" | "webhook_declined" | "webhook_error" | "webhook_timeout"; - /** @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. */ + /** + * @nullable + * @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 + * @nullable * @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 */ requested_at?: number | null; }; @@ -16661,7 +18658,10 @@ export interface components { received_credits: string[]; /** @description The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization */ received_debits: string[]; - /** @description The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization */ + /** + * @nullable + * @description The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization + */ transaction?: string | null; }; /** IssuingAuthorizationVerificationData */ @@ -16676,7 +18676,10 @@ export interface components { * @enum {string} */ address_postal_code_check: "match" | "mismatch" | "not_provided"; - /** @description The exemption applied to this authorization. */ + /** + * @nullable + * @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. @@ -16688,9 +18691,15 @@ export interface components { * @enum {string} */ expiry_check: "match" | "mismatch" | "not_provided"; - /** @description The postal code submitted as part of the authorization used for postal code verification. */ + /** + * @nullable + * @description The postal code submitted as part of the authorization used for postal code verification. + */ postal_code?: string | null; - /** @description 3D Secure details. */ + /** + * @nullable + * @description 3D Secure details. + */ three_d_secure?: components["schemas"]["issuing_authorization_three_d_secure"] | null; }; /** IssuingCardApplePay */ @@ -16698,6 +18707,7 @@ export interface components { /** @description Apple Pay Eligibility */ eligible: boolean; /** + * @nullable * @description Reason the card is ineligible for Apple Pay * @enum {string|null} */ @@ -16705,19 +18715,35 @@ export interface components { }; /** IssuingCardAuthorizationControls */ issuing_card_authorization_controls: { - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. + */ allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; - /** @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ + /** + * @nullable + * @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ allowed_merchant_countries?: string[] | null; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. + */ blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; - /** @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ + /** + * @nullable + * @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ blocked_merchant_countries?: string[] | null; - /** @description Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). */ + /** + * @nullable + * @description Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). + */ spending_limits?: components["schemas"]["issuing_card_spending_limit"][] | null; /** - * Format: currency + * @nullable * @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. + * @format currency */ spending_limits_currency?: string | null; }; @@ -16726,6 +18752,7 @@ export interface components { /** @description Google Pay Eligibility */ eligible: boolean; /** + * @nullable * @description Reason the card is ineligible for Google Pay * @enum {string|null} */ @@ -16734,25 +18761,39 @@ export interface components { /** IssuingCardShipping */ issuing_card_shipping: { address: components["schemas"]["address"]; - /** @description Address validation details for the shipment. */ + /** + * @nullable + * @description Address validation details for the shipment. + */ address_validation?: components["schemas"]["issuing_card_shipping_address_validation"] | null; /** + * @nullable * @description The delivery company that shipped a card. * @enum {string|null} */ carrier?: "dhl" | "fedex" | "royal_mail" | "usps" | null; - /** @description Additional information that may be required for clearing customs. */ + /** + * @nullable + * @description Additional information that may be required for clearing customs. + */ customs?: components["schemas"]["issuing_card_shipping_customs"] | null; /** - * Format: unix-time + * @nullable * @description A unix timestamp representing a best estimate of when the card will be delivered. + * @format unix-time */ eta?: number | null; /** @description Recipient name. */ name: string; - /** @description The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created. */ + /** + * @nullable + * @description The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created. + */ phone_number?: string | null; - /** @description Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true. */ + /** + * @nullable + * @description Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true. + */ require_signature?: boolean | null; /** * @description Shipment service, such as `standard` or `express`. @@ -16760,13 +18801,20 @@ export interface components { */ service: "express" | "priority" | "standard"; /** + * @nullable * @description The delivery status of the card. * @enum {string|null} */ status?: "canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped" | "submitted" | null; - /** @description A tracking number for a card shipment. */ + /** + * @nullable + * @description A tracking number for a card shipment. + */ tracking_number?: string | null; - /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ + /** + * @nullable + * @description A link to the shipping carrier's site where you can view detailed information about a card shipment. + */ tracking_url?: string | null; /** * @description Packaging options. @@ -16781,9 +18829,13 @@ export interface components { * @enum {string} */ mode: "disabled" | "normalization_only" | "validation_and_normalization"; - /** @description The normalized shipping address. */ + /** + * @nullable + * @description The normalized shipping address. + */ normalized_address?: components["schemas"]["address"] | null; /** + * @nullable * @description The validation result for the shipping address. * @enum {string|null} */ @@ -16791,14 +18843,20 @@ export interface components { }; /** IssuingCardShippingCustoms */ issuing_card_shipping_customs: { - /** @description A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU. */ + /** + * @nullable + * @description A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU. + */ eori_number?: string | null; }; /** IssuingCardSpendingLimit */ issuing_card_spending_limit: { /** @description Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount: number; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. + */ categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** * @description Interval (or event) to which the amount applies. @@ -16810,7 +18868,10 @@ export interface components { issuing_card_wallets: { apple_pay: components["schemas"]["issuing_card_apple_pay"]; google_pay: components["schemas"]["issuing_card_google_pay"]; - /** @description Unique identifier for a card used with digital wallets */ + /** + * @nullable + * @description Unique identifier for a card used with digital wallets + */ primary_account_identifier?: string | null; }; /** IssuingCardholderAddress */ @@ -16819,25 +18880,44 @@ export interface components { }; /** IssuingCardholderAuthorizationControls */ issuing_cardholder_authorization_controls: { - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. + */ allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; - /** @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ + /** + * @nullable + * @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. + */ allowed_merchant_countries?: string[] | null; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. + */ blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; - /** @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ + /** + * @nullable + * @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. + */ blocked_merchant_countries?: string[] | null; - /** @description Limit spending with amount-based rules that apply across this cardholder's cards. */ + /** + * @nullable + * @description Limit spending with amount-based rules that apply across this cardholder's cards. + */ spending_limits?: components["schemas"]["issuing_cardholder_spending_limit"][] | null; /** - * Format: currency + * @nullable * @description Currency of the amounts within `spending_limits`. + * @format currency */ spending_limits_currency?: string | null; }; /** IssuingCardholderCardIssuing */ issuing_cardholder_card_issuing: { - /** @description Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program. */ + /** + * @nullable + * @description Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program. + */ user_terms_acceptance?: components["schemas"]["issuing_cardholder_user_terms_acceptance"] | null; }; /** IssuingCardholderCompany */ @@ -16847,48 +18927,85 @@ export interface components { }; /** IssuingCardholderIdDocument */ issuing_cardholder_id_document: { - /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** + * @nullable + * @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + */ back?: (string | components["schemas"]["file"]) | null; - /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** + * @nullable + * @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + */ front?: (string | components["schemas"]["file"]) | null; }; /** IssuingCardholderIndividual */ issuing_cardholder_individual: { - /** @description Information related to the card_issuing program for this cardholder. */ + /** + * @nullable + * @description Information related to the card_issuing program for this cardholder. + */ card_issuing?: components["schemas"]["issuing_cardholder_card_issuing"] | null; - /** @description The date of birth of this cardholder. */ + /** + * @nullable + * @description The date of birth of this cardholder. + */ dob?: components["schemas"]["issuing_cardholder_individual_dob"] | null; - /** @description The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. */ + /** + * @nullable + * @description The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. + */ first_name?: string | null; - /** @description The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. */ + /** + * @nullable + * @description The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. + */ last_name?: string | null; - /** @description Government-issued ID document for this cardholder. */ + /** + * @nullable + * @description Government-issued ID document for this cardholder. + */ verification?: components["schemas"]["issuing_cardholder_verification"] | null; }; /** IssuingCardholderIndividualDOB */ issuing_cardholder_individual_dob: { - /** @description The day of birth, between 1 and 31. */ + /** + * @nullable + * @description The day of birth, between 1 and 31. + */ day?: number | null; - /** @description The month of birth, between 1 and 12. */ + /** + * @nullable + * @description The month of birth, between 1 and 12. + */ month?: number | null; - /** @description The four-digit year of birth. */ + /** + * @nullable + * @description The four-digit year of birth. + */ year?: number | null; }; /** IssuingCardholderRequirements */ issuing_cardholder_requirements: { /** + * @nullable * @description If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. * @enum {string|null} */ disabled_reason?: "listed" | "rejected.listed" | "requirements.past_due" | "under_review" | null; - /** @description Array of fields that need to be collected in order to verify and re-enable the cardholder. */ + /** + * @nullable + * @description Array of fields that need to be collected in order to verify and re-enable the cardholder. + */ past_due?: ("company.tax_id" | "individual.card_issuing.user_terms_acceptance.date" | "individual.card_issuing.user_terms_acceptance.ip" | "individual.dob.day" | "individual.dob.month" | "individual.dob.year" | "individual.first_name" | "individual.last_name" | "individual.verification.document")[] | null; }; /** IssuingCardholderSpendingLimit */ issuing_cardholder_spending_limit: { /** @description Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount: number; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ + /** + * @nullable + * @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. + */ categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** * @description Interval (or event) to which the amount applies. @@ -16899,71 +19016,119 @@ export interface components { /** IssuingCardholderUserTermsAcceptance */ issuing_cardholder_user_terms_acceptance: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the cardholder accepted the Authorized User Terms. + * @format unix-time */ date?: number | null; - /** @description The IP address from which the cardholder accepted the Authorized User Terms. */ + /** + * @nullable + * @description The IP address from which the cardholder accepted the Authorized User Terms. + */ ip?: string | null; - /** @description The user agent of the browser from which the cardholder accepted the Authorized User Terms. */ + /** + * @nullable + * @description The user agent of the browser from which the cardholder accepted the Authorized User Terms. + */ user_agent?: string | null; }; /** IssuingCardholderVerification */ issuing_cardholder_verification: { - /** @description An identifying document, either a passport or local ID card. */ + /** + * @nullable + * @description An identifying document, either a passport or local ID card. + */ document?: components["schemas"]["issuing_cardholder_id_document"] | null; }; /** IssuingDisputeCanceledEvidence */ issuing_dispute_canceled_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; /** - * Format: unix-time + * @nullable * @description Date when order was canceled. + * @format unix-time */ canceled_at?: number | null; - /** @description Whether the cardholder was provided with a cancellation policy. */ + /** + * @nullable + * @description Whether the cardholder was provided with a cancellation policy. + */ cancellation_policy_provided?: boolean | null; - /** @description Reason for canceling the order. */ + /** + * @nullable + * @description Reason for canceling the order. + */ cancellation_reason?: string | null; /** - * Format: unix-time + * @nullable * @description Date when the cardholder expected to receive the product. + * @format unix-time */ expected_at?: number | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; - /** @description Description of the merchandise or service that was purchased. */ + /** + * @nullable + * @description Description of the merchandise or service that was purchased. + */ product_description?: string | null; /** + * @nullable * @description Whether the product was a merchandise or service. * @enum {string|null} */ product_type?: "merchandise" | "service" | null; /** + * @nullable * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ return_status?: "merchant_rejected" | "successful" | null; /** - * Format: unix-time + * @nullable * @description Date when the product was returned or attempted to be returned. + * @format unix-time */ returned_at?: number | null; }; /** IssuingDisputeDuplicateEvidence */ issuing_dispute_duplicate_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for. + */ card_statement?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash. + */ cash_receipt?: (string | components["schemas"]["file"]) | null; - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product. + */ check_image?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; - /** @description Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. */ + /** + * @nullable + * @description Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. + */ original_transaction?: string | null; }; /** IssuingDisputeEvidence */ @@ -16984,56 +19149,91 @@ export interface components { }; /** IssuingDisputeFraudulentEvidence */ issuing_dispute_fraudulent_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; }; /** IssuingDisputeMerchandiseNotAsDescribedEvidence */ issuing_dispute_merchandise_not_as_described_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; /** - * Format: unix-time + * @nullable * @description Date when the product was received. + * @format unix-time */ received_at?: number | null; - /** @description Description of the cardholder's attempt to return the product. */ + /** + * @nullable + * @description Description of the cardholder's attempt to return the product. + */ return_description?: string | null; /** + * @nullable * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ return_status?: "merchant_rejected" | "successful" | null; /** - * Format: unix-time + * @nullable * @description Date when the product was returned or attempted to be returned. + * @format unix-time */ returned_at?: number | null; }; /** IssuingDisputeNoValidAuthorizationEvidence */ issuing_dispute_no_valid_authorization_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; }; /** IssuingDisputeNotReceivedEvidence */ issuing_dispute_not_received_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; /** - * Format: unix-time + * @nullable * @description Date when the cardholder expected to receive the product. + * @format unix-time */ expected_at?: number | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; - /** @description Description of the merchandise or service that was purchased. */ + /** + * @nullable + * @description Description of the merchandise or service that was purchased. + */ product_description?: string | null; /** + * @nullable * @description Whether the product was a merchandise or service. * @enum {string|null} */ @@ -17041,13 +19241,23 @@ export interface components { }; /** IssuingDisputeOtherEvidence */ issuing_dispute_other_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; - /** @description Description of the merchandise or service that was purchased. */ + /** + * @nullable + * @description Description of the merchandise or service that was purchased. + */ product_description?: string | null; /** + * @nullable * @description Whether the product was a merchandise or service. * @enum {string|null} */ @@ -17055,26 +19265,40 @@ export interface components { }; /** IssuingDisputeServiceNotAsDescribedEvidence */ issuing_dispute_service_not_as_described_evidence: { - /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /** + * @nullable + * @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. + */ additional_documentation?: (string | components["schemas"]["file"]) | null; /** - * Format: unix-time + * @nullable * @description Date when order was canceled. + * @format unix-time */ canceled_at?: number | null; - /** @description Reason for canceling the order. */ + /** + * @nullable + * @description Reason for canceling the order. + */ cancellation_reason?: string | null; - /** @description Explanation of why the cardholder is disputing this transaction. */ + /** + * @nullable + * @description Explanation of why the cardholder is disputing this transaction. + */ explanation?: string | null; /** - * Format: unix-time + * @nullable * @description Date when the product was received. + * @format unix-time */ received_at?: number | null; }; /** IssuingDisputeTreasury */ issuing_dispute_treasury: { - /** @description The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute */ + /** + * @nullable + * @description The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute + */ debit_reversal?: string | null; /** @description The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed. */ received_debit: string; @@ -17168,27 +19392,48 @@ export interface components { }; /** IssuingPersonalizationDesignCarrierText */ issuing_personalization_design_carrier_text: { - /** @description The footer body text of the carrier letter. */ + /** + * @nullable + * @description The footer body text of the carrier letter. + */ footer_body?: string | null; - /** @description The footer title text of the carrier letter. */ + /** + * @nullable + * @description The footer title text of the carrier letter. + */ footer_title?: string | null; - /** @description The header body text of the carrier letter. */ + /** + * @nullable + * @description The header body text of the carrier letter. + */ header_body?: string | null; - /** @description The header title text of the carrier letter. */ + /** + * @nullable + * @description The header title text of the carrier letter. + */ header_title?: string | null; }; /** IssuingPersonalizationDesignPreferences */ issuing_personalization_design_preferences: { /** @description Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design. */ is_default: boolean; - /** @description Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist. */ + /** + * @nullable + * @description Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist. + */ is_platform_default?: boolean | null; }; /** IssuingPersonalizationDesignRejectionReasons */ issuing_personalization_design_rejection_reasons: { - /** @description The reason(s) the card logo was rejected. */ + /** + * @nullable + * @description The reason(s) the card logo was rejected. + */ card_logo?: ("geographic_location" | "inappropriate" | "network_name" | "non_binary_image" | "non_fiat_currency" | "other" | "other_entity" | "promotional_material")[] | null; - /** @description The reason(s) the carrier text was rejected. */ + /** + * @nullable + * @description The reason(s) the carrier text was rejected. + */ carrier_text?: ("geographic_location" | "inappropriate" | "network_name" | "non_fiat_currency" | "other" | "other_entity" | "promotional_material")[] | null; }; /** IssuingPhysicalBundleFeatures */ @@ -17211,108 +19456,191 @@ export interface components { }; /** IssuingTransactionAmountDetails */ issuing_transaction_amount_details: { - /** @description The fee charged by the ATM for the cash withdrawal. */ + /** + * @nullable + * @description The fee charged by the ATM for the cash withdrawal. + */ atm_fee?: number | null; - /** @description The amount of cash requested by the cardholder. */ + /** + * @nullable + * @description The amount of cash requested by the cardholder. + */ cashback_amount?: number | null; }; /** IssuingTransactionFleetCardholderPromptData */ issuing_transaction_fleet_cardholder_prompt_data: { - /** @description Driver ID. */ + /** + * @nullable + * @description Driver ID. + */ driver_id?: string | null; - /** @description Odometer reading. */ + /** + * @nullable + * @description Odometer reading. + */ odometer?: number | null; - /** @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. */ + /** + * @nullable + * @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. + */ unspecified_id?: string | null; - /** @description User ID. */ + /** + * @nullable + * @description User ID. + */ user_id?: string | null; - /** @description Vehicle number. */ + /** + * @nullable + * @description Vehicle number. + */ vehicle_number?: string | null; }; /** IssuingTransactionFleetData */ issuing_transaction_fleet_data: { - /** @description Answers to prompts presented to cardholder at point of sale. */ + /** + * @nullable + * @description Answers to prompts presented to cardholder at point of sale. + */ cardholder_prompt_data?: components["schemas"]["issuing_transaction_fleet_cardholder_prompt_data"] | null; - /** @description The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. */ + /** + * @nullable + * @description The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. + */ purchase_type?: string | null; - /** @description More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data. */ + /** + * @nullable + * @description More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data. + */ reported_breakdown?: components["schemas"]["issuing_transaction_fleet_reported_breakdown"] | null; - /** @description The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`. */ + /** + * @nullable + * @description The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`. + */ service_type?: string | null; }; /** IssuingTransactionFleetFuelPriceData */ issuing_transaction_fleet_fuel_price_data: { /** - * Format: decimal + * @nullable * @description Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes. + * @format decimal */ gross_amount_decimal?: string | null; }; /** IssuingTransactionFleetNonFuelPriceData */ issuing_transaction_fleet_non_fuel_price_data: { /** - * Format: decimal + * @nullable * @description Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. + * @format decimal */ gross_amount_decimal?: string | null; }; /** IssuingTransactionFleetReportedBreakdown */ issuing_transaction_fleet_reported_breakdown: { - /** @description Breakdown of fuel portion of the purchase. */ + /** + * @nullable + * @description Breakdown of fuel portion of the purchase. + */ fuel?: components["schemas"]["issuing_transaction_fleet_fuel_price_data"] | null; - /** @description Breakdown of non-fuel portion of the purchase. */ + /** + * @nullable + * @description Breakdown of non-fuel portion of the purchase. + */ non_fuel?: components["schemas"]["issuing_transaction_fleet_non_fuel_price_data"] | null; - /** @description Information about tax included in this transaction. */ + /** + * @nullable + * @description Information about tax included in this transaction. + */ tax?: components["schemas"]["issuing_transaction_fleet_tax_data"] | null; }; /** IssuingTransactionFleetTaxData */ issuing_transaction_fleet_tax_data: { /** - * Format: decimal + * @nullable * @description Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax. + * @format decimal */ local_amount_decimal?: string | null; /** - * Format: decimal + * @nullable * @description Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax. + * @format decimal */ national_amount_decimal?: string | null; }; /** IssuingTransactionFlightData */ issuing_transaction_flight_data: { - /** @description The time that the flight departed. */ + /** + * @nullable + * @description The time that the flight departed. + */ departure_at?: number | null; - /** @description The name of the passenger. */ + /** + * @nullable + * @description The name of the passenger. + */ passenger_name?: string | null; - /** @description Whether the ticket is refundable. */ + /** + * @nullable + * @description Whether the ticket is refundable. + */ refundable?: boolean | null; - /** @description The legs of the trip. */ + /** + * @nullable + * @description The legs of the trip. + */ segments?: components["schemas"]["issuing_transaction_flight_data_leg"][] | null; - /** @description The travel agency that issued the ticket. */ + /** + * @nullable + * @description The travel agency that issued the ticket. + */ travel_agency?: string | null; }; /** IssuingTransactionFlightDataLeg */ issuing_transaction_flight_data_leg: { - /** @description The three-letter IATA airport code of the flight's destination. */ + /** + * @nullable + * @description The three-letter IATA airport code of the flight's destination. + */ arrival_airport_code?: string | null; - /** @description The airline carrier code. */ + /** + * @nullable + * @description The airline carrier code. + */ carrier?: string | null; - /** @description The three-letter IATA airport code that the flight departed from. */ + /** + * @nullable + * @description The three-letter IATA airport code that the flight departed from. + */ departure_airport_code?: string | null; - /** @description The flight number. */ + /** + * @nullable + * @description The flight number. + */ flight_number?: string | null; - /** @description The flight's service class. */ + /** + * @nullable + * @description The flight's service class. + */ service_class?: string | null; - /** @description Whether a stopover is allowed on this flight. */ + /** + * @nullable + * @description Whether a stopover is allowed on this flight. + */ stopover_allowed?: boolean | null; }; /** IssuingTransactionFuelData */ issuing_transaction_fuel_data: { - /** @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. */ + /** + * @nullable + * @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. + */ industry_product_code?: string | null; /** - * Format: decimal + * @nullable * @description The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. + * @format decimal */ quantity_decimal?: string | null; /** @description The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. */ @@ -17320,58 +19648,109 @@ export interface components { /** @description The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`. */ unit: string; /** - * Format: decimal * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. + * @format decimal */ unit_cost_decimal: string; }; /** IssuingTransactionLodgingData */ issuing_transaction_lodging_data: { - /** @description The time of checking into the lodging. */ + /** + * @nullable + * @description The time of checking into the lodging. + */ check_in_at?: number | null; - /** @description The number of nights stayed at the lodging. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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 Fleet-specific information for transactions using Fleet cards. */ + /** + * @nullable + * @description Fleet-specific information for transactions using Fleet cards. + */ fleet?: components["schemas"]["issuing_transaction_fleet_data"] | null; - /** @description Information about the flight that was purchased with this transaction. */ + /** + * @nullable + * @description Information about the flight that was purchased with this transaction. + */ flight?: components["schemas"]["issuing_transaction_flight_data"] | null; - /** @description Information about fuel that was purchased with this transaction. */ + /** + * @nullable + * @description Information about fuel that was purchased with this transaction. + */ fuel?: components["schemas"]["issuing_transaction_fuel_data"] | null; - /** @description Information about lodging that was purchased with this transaction. */ + /** + * @nullable + * @description Information about lodging that was purchased with this transaction. + */ lodging?: components["schemas"]["issuing_transaction_lodging_data"] | null; - /** @description The line items in the purchase. */ + /** + * @nullable + * @description The line items in the purchase. + */ receipt?: components["schemas"]["issuing_transaction_receipt_data"][] | null; - /** @description A merchant-specific order number. */ + /** + * @nullable + * @description A merchant-specific order number. + */ reference?: string | null; }; /** IssuingTransactionReceiptData */ issuing_transaction_receipt_data: { - /** @description The description of the item. The maximum length of this field is 26 characters. */ + /** + * @nullable + * @description The description of the item. The maximum length of this field is 26 characters. + */ description?: string | null; - /** @description The quantity of the item. */ + /** + * @nullable + * @description The quantity of the item. + */ quantity?: number | null; - /** @description The total for this line item in cents. */ + /** + * @nullable + * @description The total for this line item in cents. + */ total?: number | null; - /** @description The unit cost of the item in cents. */ + /** + * @nullable + * @description The unit cost of the item in cents. + */ unit_cost?: number | null; }; /** IssuingTransactionTreasury */ issuing_transaction_treasury: { - /** @description The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund */ + /** + * @nullable + * @description The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund + */ received_credit?: string | null; - /** @description The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture */ + /** + * @nullable + * @description The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture + */ received_debit?: string | null; }; /** @@ -17388,11 +19767,14 @@ export interface components { /** @description Total after discounts and taxes. */ amount_total: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. + */ description?: string | null; /** @description The discounts applied to the line item. */ discounts?: components["schemas"]["line_items_discount_amount"][]; @@ -17403,33 +19785,54 @@ export interface components { * @enum {string} */ object: "item"; - /** @description The price used to generate the line item. */ + /** + * @nullable + * @description The price used to generate the line item. + */ price?: components["schemas"]["price"] | null; - /** @description The quantity of products being purchased. */ + /** + * @nullable + * @description The quantity of products being purchased. + */ quantity?: number | null; /** @description The taxes applied to the line item. */ taxes?: components["schemas"]["line_items_tax_amount"][]; }; /** klarna_address */ klarna_address: { - /** @description The payer address country */ + /** + * @nullable + * @description The payer address country + */ country?: string | null; }; /** klarna_payer_details */ klarna_payer_details: { - /** @description The payer's address */ + /** + * @nullable + * @description The payer's address + */ address?: components["schemas"]["klarna_address"] | null; }; /** LegalEntityCompany */ legal_entity_company: { address?: components["schemas"]["address"]; - /** @description The Kana variation of the company's primary address (Japan only). */ + /** + * @nullable + * @description The Kana variation of the company's primary address (Japan only). + */ address_kana?: components["schemas"]["legal_entity_japan_address"] | null; - /** @description The Kanji variation of the company's primary address (Japan only). */ + /** + * @nullable + * @description The Kanji variation of the company's primary address (Japan only). + */ address_kanji?: components["schemas"]["legal_entity_japan_address"] | null; /** @description Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). */ directors_provided?: boolean; - /** @description This hash is used to attest that the director information provided to Stripe is both current and correct. */ + /** + * @nullable + * @description This hash is used to attest that the director information provided to Stripe is both current and correct. + */ directorship_declaration?: components["schemas"]["legal_entity_directorship_declaration"] | null; /** @description Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. */ executives_provided?: boolean; @@ -17437,19 +19840,34 @@ export interface components { export_license_id?: string; /** @description The purpose code to use for export transactions (India only). */ export_purpose_code?: string; - /** @description The company's legal name. */ + /** + * @nullable + * @description The company's legal name. + */ name?: string | null; - /** @description The Kana variation of the company's legal name (Japan only). */ + /** + * @nullable + * @description The Kana variation of the company's legal name (Japan only). + */ name_kana?: string | null; - /** @description The Kanji variation of the company's legal name (Japan only). */ + /** + * @nullable + * @description The Kanji variation of the company's legal name (Japan only). + */ name_kanji?: string | null; /** @description Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). */ owners_provided?: boolean; - /** @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ + /** + * @nullable + * @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. + */ ownership_declaration?: components["schemas"]["legal_entity_ubo_declaration"] | null; /** @enum {string} */ ownership_exemption_reason?: "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; - /** @description The company's phone number (used for verification). */ + /** + * @nullable + * @description The company's phone number (used for verification). + */ phone?: string | null; /** * @description The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. @@ -17462,7 +19880,10 @@ export interface components { tax_id_registrar?: string; /** @description Whether the company's business VAT number was provided. */ vat_id_provided?: boolean; - /** @description Information on the verification state of the company. */ + /** + * @nullable + * @description Information on the verification state of the company. + */ verification?: components["schemas"]["legal_entity_company_verification"] | null; }; /** LegalEntityCompanyVerification */ @@ -17471,60 +19892,118 @@ export interface components { }; /** LegalEntityCompanyVerificationDocument */ legal_entity_company_verification_document: { - /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ + /** + * @nullable + * @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. + */ back?: (string | components["schemas"]["file"]) | null; - /** @description A user-displayable string describing the verification state of this document. */ + /** + * @nullable + * @description A user-displayable string describing the verification state of this document. + */ details?: string | null; - /** @description One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document. */ + /** + * @nullable + * @description One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document. + */ details_code?: string | null; - /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ + /** + * @nullable + * @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. + */ front?: (string | components["schemas"]["file"]) | null; }; /** LegalEntityDirectorshipDeclaration */ legal_entity_directorship_declaration: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the directorship declaration attestation was made. + * @format unix-time */ date?: number | null; - /** @description The IP address from which the directorship declaration attestation was made. */ + /** + * @nullable + * @description The IP address from which the directorship declaration attestation was made. + */ ip?: string | null; - /** @description The user-agent string from the browser where the directorship declaration attestation was made. */ + /** + * @nullable + * @description The user-agent string from the browser where the directorship declaration attestation was made. + */ user_agent?: string | null; }; /** LegalEntityDOB */ legal_entity_dob: { - /** @description The day of birth, between 1 and 31. */ + /** + * @nullable + * @description The day of birth, between 1 and 31. + */ day?: number | null; - /** @description The month of birth, between 1 and 12. */ + /** + * @nullable + * @description The month of birth, between 1 and 12. + */ month?: number | null; - /** @description The four-digit year of birth. */ + /** + * @nullable + * @description The four-digit year of birth. + */ year?: number | null; }; /** LegalEntityJapanAddress */ legal_entity_japan_address: { - /** @description City/Ward. */ + /** + * @nullable + * @description City/Ward. + */ city?: string | null; - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; - /** @description Block/Building number. */ + /** + * @nullable + * @description Block/Building number. + */ line1?: string | null; - /** @description Building details. */ + /** + * @nullable + * @description Building details. + */ line2?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ postal_code?: string | null; - /** @description Prefecture. */ + /** + * @nullable + * @description Prefecture. + */ state?: string | null; - /** @description Town/cho-me. */ + /** + * @nullable + * @description Town/cho-me. + */ town?: string | null; }; /** LegalEntityPersonVerification */ legal_entity_person_verification: { - /** @description A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. */ + /** + * @nullable + * @description A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. + */ additional_document?: components["schemas"]["legal_entity_person_verification_document"] | null; - /** @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ + /** + * @nullable + * @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". + */ details?: string | null; - /** @description One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. */ + /** + * @nullable + * @description One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. + */ details_code?: string | null; document?: components["schemas"]["legal_entity_person_verification_document"]; /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ @@ -17532,25 +20011,44 @@ export interface components { }; /** LegalEntityPersonVerificationDocument */ legal_entity_person_verification_document: { - /** @description The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** + * @nullable + * @description The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + */ back?: (string | components["schemas"]["file"]) | null; - /** @description A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read". */ + /** + * @nullable + * @description A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read". + */ details?: string | null; - /** @description One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document. */ + /** + * @nullable + * @description One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document. + */ details_code?: string | null; - /** @description The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** + * @nullable + * @description The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. + */ front?: (string | components["schemas"]["file"]) | null; }; /** LegalEntityUBODeclaration */ legal_entity_ubo_declaration: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the beneficial owner attestation was made. + * @format unix-time */ date?: number | null; - /** @description The IP address from which the beneficial owner attestation was made. */ + /** + * @nullable + * @description The IP address from which the beneficial owner attestation was made. + */ ip?: string | null; - /** @description The user-agent string from the browser where the beneficial owner attestation was made. */ + /** + * @nullable + * @description The user-agent string from the browser where the beneficial owner attestation was made. + */ user_agent?: string | null; }; /** @@ -17562,16 +20060,25 @@ export interface components { line_item: { /** @description The amount, in cents (or local equivalent). */ amount: number; - /** @description The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. */ + /** + * @nullable + * @description The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. + */ amount_excluding_tax?: number | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description The amount of discount calculated per discount for this line item. */ + /** + * @nullable + * @description The amount of discount calculated per discount for this line item. + */ discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; /** @description If true, discounts will apply to this line item. Always false for prorations. */ discountable: boolean; @@ -17579,7 +20086,10 @@ export interface components { discounts: (string | components["schemas"]["discount"])[]; /** @description Unique identifier for the object. */ id: string; - /** @description The ID of the invoice that contains this line item. */ + /** + * @nullable + * @description The ID of the invoice that contains this line item. + */ invoice?: string | null; /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ invoice_item?: string | components["schemas"]["invoiceitem"]; @@ -17595,17 +20105,32 @@ export interface components { */ object: "line_item"; period: components["schemas"]["invoice_line_item_period"]; - /** @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item. */ + /** + * @nullable + * @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item. + */ pretax_credit_amounts?: components["schemas"]["invoices_resource_pretax_credit_amount"][] | null; - /** @description The price of the line item. */ + /** + * @nullable + * @description The price of the line item. + */ price?: components["schemas"]["price"] | null; /** @description Whether this is a proration. */ proration: boolean; - /** @description Additional details for proration line items */ + /** + * @nullable + * @description Additional details for proration line items + */ proration_details?: components["schemas"]["invoices_resource_line_items_proration_details"] | null; - /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ + /** + * @nullable + * @description The quantity of the subscription, if the line item is a subscription or a proration. + */ quantity?: number | null; - /** @description The subscription that the invoice item pertains to, if any. */ + /** + * @nullable + * @description The subscription that the invoice item pertains to, if any. + */ subscription?: (string | components["schemas"]["subscription"]) | null; /** @description The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription. */ subscription_item?: string | components["schemas"]["subscription_item"]; @@ -17619,8 +20144,9 @@ export interface components { */ type: "invoiceitem" | "subscription"; /** - * Format: decimal + * @nullable * @description The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts. + * @format decimal */ unit_amount_excluding_tax?: string | null; }; @@ -17636,11 +20162,15 @@ export interface components { amount: number; rate: components["schemas"]["tax_rate"]; /** + * @nullable * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. * @enum {string|null} */ taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in cents (or local equivalent). */ + /** + * @nullable + * @description The amount on which tax is calculated, in cents (or local equivalent). + */ taxable_amount?: number | null; }; /** linked_account_options_us_bank_account */ @@ -17648,7 +20178,10 @@ export interface components { filters?: components["schemas"]["payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters"]; /** @description The list of permissions to request. The `payment_method` permission must be included. */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - /** @description Data features requested to be retrieved upon account creation. */ + /** + * @nullable + * @description Data features requested to be retrieved upon account creation. + */ prefetch?: ("balances" | "ownership" | "transactions")[] | null; /** @description For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ return_url?: string; @@ -17659,8 +20192,8 @@ export interface components { */ login_link: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @@ -17708,7 +20241,10 @@ export interface components { mandate_acss_debit: { /** @description List of Stripe products where this mandate can be selected automatically. */ default_for?: ("invoice" | "subscription")[]; - /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /** + * @nullable + * @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. + */ interval_description?: string | null; /** * @description Payment schedule for the mandate. @@ -17738,6 +20274,7 @@ export interface components { /** @description The unique reference identifying the mandate on the Bacs network. */ reference: string; /** + * @nullable * @description When the mandate is revoked on the Bacs network this field displays the reason for the revocation. * @enum {string|null} */ @@ -17775,9 +20312,15 @@ export interface components { }; /** mandate_paypal */ mandate_paypal: { - /** @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. */ + /** + * @nullable + * @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. + */ billing_agreement_id?: string | null; - /** @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ + /** + * @nullable + * @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. + */ payer_id?: string | null; }; /** mandate_revolut_pay */ @@ -17794,8 +20337,8 @@ export interface components { /** @description The amount of the payment on a single use mandate. */ amount: number; /** - * Format: currency * @description The currency of the payment on a single use mandate. + * @format currency */ currency: string; }; @@ -17811,7 +20354,10 @@ export interface components { networks: { /** @description All available networks for the card. */ available: string[]; - /** @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. */ + /** + * @nullable + * @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. + */ preferred?: string | null; }; /** NotificationEventData */ @@ -17823,18 +20369,30 @@ export interface components { }; /** NotificationEventRequest */ notification_event_request: { - /** @description ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. */ + /** + * @nullable + * @description ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. + */ id?: string | null; - /** @description The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. */ + /** + * @nullable + * @description The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. + */ idempotency_key?: string | null; }; /** offline_acceptance */ offline_acceptance: Record; /** online_acceptance */ online_acceptance: { - /** @description The customer accepts the mandate from this IP address. */ + /** + * @nullable + * @description The customer accepts the mandate from this IP address. + */ ip_address?: string | null; - /** @description The customer accepts the mandate using the user agent of the browser. */ + /** + * @nullable + * @description The customer accepts the mandate using the user agent of the browser. + */ user_agent?: string | null; }; /** OutboundPaymentsPaymentMethodDetails */ @@ -17861,20 +20419,31 @@ export interface components { /** outbound_payments_payment_method_details_us_bank_account */ outbound_payments_payment_method_details_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; @@ -17883,7 +20452,10 @@ export interface components { * @enum {string} */ network: "ach" | "us_domestic_wire"; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; }; /** OutboundTransfersPaymentMethodDetails */ @@ -17910,20 +20482,31 @@ export interface components { /** outbound_transfers_payment_method_details_us_bank_account */ outbound_transfers_payment_method_details_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; @@ -17932,7 +20515,10 @@ export interface components { * @enum {string} */ network: "ach" | "us_domestic_wire"; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; }; /** PackageDimensions */ @@ -17980,7 +20566,10 @@ export interface components { * @enum {string} */ allow_redirects?: "always" | "never"; - /** @description Automatically calculates compatible payment methods */ + /** + * @nullable + * @description Automatically calculates compatible payment methods + */ enabled?: boolean | null; }; /** PaymentFlowsInstallmentOptions */ @@ -17994,9 +20583,15 @@ export interface components { payment_flows_private_payment_methods_alipay_details: { /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ buyer_id?: string; - /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. + */ fingerprint?: string | null; - /** @description Transaction ID of this particular Alipay transaction. */ + /** + * @nullable + * @description Transaction ID of this particular Alipay transaction. + */ transaction_id?: string | null; }; /** PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization */ @@ -18062,11 +20657,20 @@ export interface components { }; /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ payment_flows_private_payment_methods_klarna_dob: { - /** @description The day of birth, between 1 and 31. */ + /** + * @nullable + * @description The day of birth, between 1 and 31. + */ day?: number | null; - /** @description The month of birth, between 1 and 12. */ + /** + * @nullable + * @description The month of birth, between 1 and 12. + */ month?: number | null; - /** @description The four-digit year of birth. */ + /** + * @nullable + * @description The four-digit year of birth. + */ year?: number | null; }; /** PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions */ @@ -18120,18 +20724,29 @@ export interface components { amount_details?: components["schemas"]["payment_flows_amount_details"] | components["schemas"]["payment_flows_amount_details_client"]; /** @description Amount that this PaymentIntent collects. */ amount_received?: number; - /** @description ID of the Connect application that created the PaymentIntent. */ + /** + * @nullable + * @description ID of the Connect application that created the PaymentIntent. + */ application?: (string | components["schemas"]["application"]) | null; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** + * @nullable + * @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + */ application_fee_amount?: number | null; - /** @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) */ + /** + * @nullable + * @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) + */ automatic_payment_methods?: components["schemas"]["payment_flows_automatic_payment_methods_payment_intent"] | null; /** - * Format: unix-time + * @nullable * @description Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. + * @format unix-time */ canceled_at?: number | null; /** + * @nullable * @description Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`). * @enum {string|null} */ @@ -18142,6 +20757,7 @@ export interface components { */ capture_method: "automatic" | "automatic_async" | "manual"; /** + * @nullable * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. @@ -18155,16 +20771,17 @@ export interface components { */ confirmation_method: "automatic" | "manual"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** + * @nullable * @description ID of the Customer this PaymentIntent belongs to, if one exists. * * Payment methods attached to other Customers cannot be used with this PaymentIntent. @@ -18172,15 +20789,27 @@ export interface components { * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description Unique identifier for the object. */ id: string; - /** @description ID of the invoice that created this PaymentIntent, if it exists. */ + /** + * @nullable + * @description ID of the invoice that created this PaymentIntent, if it exists. + */ invoice?: (string | components["schemas"]["invoice"]) | null; - /** @description The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. */ + /** + * @nullable + * @description The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. + */ last_payment_error?: components["schemas"]["api_errors"] | null; - /** @description ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. */ + /** + * @nullable + * @description ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. + */ latest_charge?: (string | components["schemas"]["charge"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -18188,30 +20817,55 @@ export interface components { metadata?: { [key: string]: string; }; - /** @description If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. */ + /** + * @nullable + * @description If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. + */ next_action?: components["schemas"]["payment_intent_next_action"] | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "payment_intent"; - /** @description The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ + /** + * @nullable + * @description The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description ID of the payment method used in this PaymentIntent. */ + /** + * @nullable + * @description ID of the payment method used in this PaymentIntent. + */ payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent. */ + /** + * @nullable + * @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent. + */ payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; - /** @description Payment-method-specific configuration for this PaymentIntent. */ + /** + * @nullable + * @description Payment-method-specific configuration for this PaymentIntent. + */ payment_method_options?: components["schemas"]["payment_intent_payment_method_options"] | null; /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ payment_method_types: string[]; - /** @description If present, this property tells you about the processing state of the payment. */ + /** + * @nullable + * @description If present, this property tells you about the processing state of the payment. + */ processing?: components["schemas"]["payment_intent_processing"] | null; - /** @description Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ + /** + * @nullable + * @description Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). + */ receipt_email?: string | null; - /** @description ID of the review associated with this PaymentIntent, if any. */ + /** + * @nullable + * @description ID of the review associated with this PaymentIntent, if any. + */ review?: (string | components["schemas"]["review"]) | null; /** + * @nullable * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. @@ -18222,24 +20876,37 @@ export interface components { * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; - /** @description Shipping information for this PaymentIntent. */ + /** + * @nullable + * @description Shipping information for this PaymentIntent. + */ shipping?: components["schemas"]["shipping"] | null; /** + * @nullable * @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). * * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string | null; - /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ + /** + * @nullable + * @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. + */ statement_descriptor_suffix?: string | null; /** * @description Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses). * @enum {string} */ status: "canceled" | "processing" | "requires_action" | "requires_capture" | "requires_confirmation" | "requires_payment_method" | "succeeded"; - /** @description The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** + * @nullable + * @description The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + */ transfer_data?: components["schemas"]["transfer_data"] | null; - /** @description A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). */ + /** + * @nullable + * @description A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). + */ transfer_group?: string | null; }; /** PaymentIntentCardProcessing */ @@ -18272,37 +20939,63 @@ export interface components { }; /** PaymentIntentNextActionAlipayHandleRedirect */ payment_intent_next_action_alipay_handle_redirect: { - /** @description The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App. */ + /** + * @nullable + * @description The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App. + */ native_data?: string | null; - /** @description The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. */ + /** + * @nullable + * @description The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. + */ native_url?: string | null; - /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ + /** + * @nullable + * @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. + */ return_url?: string | null; - /** @description The URL you must redirect your customer to in order to authenticate the payment. */ + /** + * @nullable + * @description The URL you must redirect your customer to in order to authenticate the payment. + */ url?: string | null; }; /** payment_intent_next_action_boleto */ payment_intent_next_action_boleto: { /** - * Format: unix-time + * @nullable * @description The timestamp after which the boleto expires. + * @format unix-time */ expires_at?: number | null; - /** @description The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. */ + /** + * @nullable + * @description The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. + */ hosted_voucher_url?: string | null; - /** @description The boleto number. */ + /** + * @nullable + * @description The boleto number. + */ number?: string | null; - /** @description The URL to the downloadable boleto voucher PDF. */ + /** + * @nullable + * @description The URL to the downloadable boleto voucher PDF. + */ pdf?: string | null; }; /** PaymentIntentNextActionCardAwaitNotification */ payment_intent_next_action_card_await_notification: { /** - * Format: unix-time + * @nullable * @description The time that payment will be attempted. If customer approval is required, they need to provide approval before this time. + * @format unix-time */ charge_attempt_at?: number | null; - /** @description For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required. */ + /** + * @nullable + * @description For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required. + */ customer_approval_required?: boolean | null; }; /** PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode */ @@ -18316,8 +21009,8 @@ export interface components { /** PaymentIntentNextActionCashappQRCode */ payment_intent_next_action_cashapp_qr_code: { /** - * Format: unix-time * @description The date (unix timestamp) when the QR code expires. + * @format unix-time */ expires_at: number; /** @description The image_url_png string used to render QR code */ @@ -18327,18 +21020,28 @@ export interface components { }; /** PaymentIntentNextActionDisplayBankTransferInstructions */ payment_intent_next_action_display_bank_transfer_instructions: { - /** @description The remaining amount that needs to be transferred to complete the payment. */ + /** + * @nullable + * @description The remaining amount that needs to be transferred to complete the payment. + */ amount_remaining?: number | null; /** - * Format: currency + * @nullable * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string | null; /** @description A list of financial addresses that can be used to fund the customer balance */ financial_addresses?: components["schemas"]["funding_instructions_bank_transfer_financial_address"][]; - /** @description A link to a hosted page that guides your customer through completing the transfer. */ + /** + * @nullable + * @description A link to a hosted page that guides your customer through completing the transfer. + */ hosted_instructions_url?: string | null; - /** @description A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer. */ + /** + * @nullable + * @description A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer. + */ reference?: string | null; /** * @description Type of bank transfer @@ -18348,38 +21051,58 @@ export interface components { }; /** PaymentIntentNextActionDisplayMultibancoDetails */ payment_intent_next_action_display_multibanco_details: { - /** @description Entity number associated with this Multibanco payment. */ + /** + * @nullable + * @description Entity number associated with this Multibanco payment. + */ entity?: string | null; /** - * Format: unix-time + * @nullable * @description The timestamp at which the Multibanco voucher expires. + * @format unix-time */ expires_at?: number | null; - /** @description The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher. */ + /** + * @nullable + * @description The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher. + */ hosted_voucher_url?: string | null; - /** @description Reference number associated with this Multibanco payment. */ + /** + * @nullable + * @description Reference number associated with this Multibanco payment. + */ reference?: string | null; }; /** PaymentIntentNextActionDisplayOxxoDetails */ payment_intent_next_action_display_oxxo_details: { /** - * Format: unix-time + * @nullable * @description The timestamp after which the OXXO voucher expires. + * @format unix-time */ expires_after?: number | null; - /** @description The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. */ + /** + * @nullable + * @description The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. + */ hosted_voucher_url?: string | null; - /** @description OXXO reference number. */ + /** + * @nullable + * @description OXXO reference number. + */ number?: string | null; }; /** payment_intent_next_action_konbini */ payment_intent_next_action_konbini: { /** - * Format: unix-time * @description The timestamp at which the pending Konbini payment expires. + * @format unix-time */ expires_at: number; - /** @description The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher. */ + /** + * @nullable + * @description The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher. + */ hosted_voucher_url?: string | null; stores: components["schemas"]["payment_intent_next_action_konbini_stores"]; }; @@ -18413,20 +21136,35 @@ export interface components { }; /** payment_intent_next_action_konbini_stores */ payment_intent_next_action_konbini_stores: { - /** @description FamilyMart instruction details. */ + /** + * @nullable + * @description FamilyMart instruction details. + */ familymart?: components["schemas"]["payment_intent_next_action_konbini_familymart"] | null; - /** @description Lawson instruction details. */ + /** + * @nullable + * @description Lawson instruction details. + */ lawson?: components["schemas"]["payment_intent_next_action_konbini_lawson"] | null; - /** @description Ministop instruction details. */ + /** + * @nullable + * @description Ministop instruction details. + */ ministop?: components["schemas"]["payment_intent_next_action_konbini_ministop"] | null; - /** @description Seicomart instruction details. */ + /** + * @nullable + * @description Seicomart instruction details. + */ seicomart?: components["schemas"]["payment_intent_next_action_konbini_seicomart"] | null; }; /** PaymentIntentNextActionPaynowDisplayQrCode */ payment_intent_next_action_paynow_display_qr_code: { /** @description The raw data string used to generate QR code, it should be used together with QR code library. */ data: string; - /** @description The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code. */ + /** + * @nullable + * @description The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code. + */ hosted_instructions_url?: string | null; /** @description The image_url_png string used to render QR code */ image_url_png: string; @@ -18459,9 +21197,15 @@ export interface components { }; /** PaymentIntentNextActionRedirectToUrl */ payment_intent_next_action_redirect_to_url: { - /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ + /** + * @nullable + * @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. + */ return_url?: string | null; - /** @description The URL you must redirect your customer to in order to authenticate the payment. */ + /** + * @nullable + * @description The URL you must redirect your customer to in order to authenticate the payment. + */ url?: string | null; }; /** PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode */ @@ -18482,13 +21226,14 @@ export interface components { /** PaymentIntentNextActionVerifyWithMicrodeposits */ payment_intent_next_action_verify_with_microdeposits: { /** - * Format: unix-time * @description The timestamp when the microdeposits are expected to land. + * @format unix-time */ arrival_date: number; /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ hosted_verification_url: string; /** + * @nullable * @description The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. * @enum {string|null} */ @@ -18649,14 +21394,19 @@ export interface components { */ capture_method?: "manual"; /** + * @nullable * @description Installment details for this payment (Mexico only). * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ installments?: components["schemas"]["payment_method_options_card_installments"] | null; - /** @description Configuration options for setting up an eMandate for cards issued in India. */ + /** + * @nullable + * @description Configuration options for setting up an eMandate for cards issued in India. + */ mandate_options?: components["schemas"]["payment_method_options_card_mandate_options"] | null; /** + * @nullable * @description Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time. * @enum {string|null} */ @@ -18682,6 +21432,7 @@ export interface components { */ request_overcapture?: "if_available" | "never"; /** + * @nullable * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ @@ -18741,14 +21492,19 @@ export interface components { payment_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ custom_mandate_url?: string; - /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /** + * @nullable + * @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. + */ interval_description?: string | null; /** + * @nullable * @description Payment schedule for the mandate. * @enum {string|null} */ payment_schedule?: "combined" | "interval" | "sporadic" | null; /** + * @nullable * @description Transaction type of the mandate. * @enum {string|null} */ @@ -18800,7 +21556,10 @@ export interface components { }; /** payment_intent_payment_method_options_swish */ payment_intent_payment_method_options_swish: { - /** @description A reference for this payment to be displayed in the Swish app. */ + /** + * @nullable + * @description A reference for this payment to be displayed in the Swish app. + */ reference?: string | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -18851,11 +21610,15 @@ export interface components { }; /** PaymentIntentProcessingCustomerNotification */ payment_intent_processing_customer_notification: { - /** @description Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank. */ + /** + * @nullable + * @description Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank. + */ approval_requested?: boolean | null; /** - * Format: unix-time + * @nullable * @description If customer approval is required, they need to provide approval before this time. + * @format unix-time */ completes_at?: number | null; }; @@ -18903,11 +21666,20 @@ export interface components { after_completion: components["schemas"]["payment_links_resource_after_completion"]; /** @description Whether user redeemable promotion codes are enabled. */ allow_promotion_codes: boolean; - /** @description The ID of the Connect application that created the Payment Link. */ + /** + * @nullable + * @description The ID of the Connect application that created the Payment Link. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. */ + /** + * @nullable + * @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. + */ application_fee_amount?: number | null; - /** @description This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. */ + /** + * @nullable + * @description This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. + */ application_fee_percent?: number | null; automatic_tax: components["schemas"]["payment_links_resource_automatic_tax"]; /** @@ -18915,11 +21687,14 @@ export interface components { * @enum {string} */ billing_address_collection: "auto" | "required"; - /** @description When set, provides configuration to gather active consent from customers. */ + /** + * @nullable + * @description When set, provides configuration to gather active consent from customers. + */ consent_collection?: components["schemas"]["payment_links_resource_consent_collection"] | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ @@ -18932,9 +21707,15 @@ export interface components { customer_creation: "always" | "if_required"; /** @description Unique identifier for the object. */ id: string; - /** @description The custom message to be displayed to a customer when a payment link is no longer active. */ + /** + * @nullable + * @description The custom message to be displayed to a customer when a payment link is no longer active. + */ inactive_message?: string | null; - /** @description Configuration for creating invoice for payment mode payment links. */ + /** + * @nullable + * @description Configuration for creating invoice for payment mode payment links. + */ invoice_creation?: components["schemas"]["payment_links_resource_invoice_creation"] | null; /** * PaymentLinksResourceListLineItems @@ -18964,21 +21745,36 @@ export interface components { * @enum {string} */ object: "payment_link"; - /** @description The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. */ + /** + * @nullable + * @description The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description Indicates the parameters to be passed to PaymentIntent creation during checkout. */ + /** + * @nullable + * @description Indicates the parameters to be passed to PaymentIntent creation during checkout. + */ payment_intent_data?: components["schemas"]["payment_links_resource_payment_intent_data"] | null; /** * @description Configuration for collecting a payment method during checkout. Defaults to `always`. * @enum {string} */ payment_method_collection: "always" | "if_required"; - /** @description The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ + /** + * @nullable + * @description The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). + */ payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; - /** @description Settings that restrict the usage of a payment link. */ + /** + * @nullable + * @description Settings that restrict the usage of a payment link. + */ restrictions?: components["schemas"]["payment_links_resource_restrictions"] | null; - /** @description Configuration for collecting the customer's shipping address. */ + /** + * @nullable + * @description Configuration for collecting the customer's shipping address. + */ shipping_address_collection?: components["schemas"]["payment_links_resource_shipping_address_collection"] | null; /** @description The shipping rate options applied to the session. */ shipping_options: components["schemas"]["payment_links_resource_shipping_option"][]; @@ -18987,10 +21783,16 @@ export interface components { * @enum {string} */ submit_type: "auto" | "book" | "donate" | "pay" | "subscribe"; - /** @description When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. */ + /** + * @nullable + * @description When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. + */ subscription_data?: components["schemas"]["payment_links_resource_subscription_data"] | null; tax_id_collection: components["schemas"]["payment_links_resource_tax_id_collection"]; - /** @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. */ + /** + * @nullable + * @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. + */ transfer_data?: components["schemas"]["payment_links_resource_transfer_data"] | null; /** @description The public URL that can be shared with customers. */ url: string; @@ -19009,7 +21811,10 @@ export interface components { payment_links_resource_automatic_tax: { /** @description If `true`, tax will be calculated automatically using the customer's location. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; }; /** PaymentLinksResourceCompletedSessions */ @@ -19021,7 +21826,10 @@ export interface components { }; /** PaymentLinksResourceCompletionBehaviorConfirmationPage */ payment_links_resource_completion_behavior_confirmation_page: { - /** @description The custom message that is displayed to the customer after the purchase is complete. */ + /** + * @nullable + * @description The custom message that is displayed to the customer after the purchase is complete. + */ custom_message?: string | null; }; /** PaymentLinksResourceCompletionBehaviorRedirect */ @@ -19031,14 +21839,19 @@ export interface components { }; /** PaymentLinksResourceConsentCollection */ payment_links_resource_consent_collection: { - /** @description Settings related to the payment method reuse text shown in the Checkout UI. */ + /** + * @nullable + * @description Settings related to the payment method reuse text shown in the Checkout UI. + */ payment_method_reuse_agreement?: components["schemas"]["payment_links_resource_payment_method_reuse_agreement"] | null; /** + * @nullable * @description If set to `auto`, enables the collection of customer consent for promotional communications. * @enum {string|null} */ promotions?: "auto" | "none" | null; /** + * @nullable * @description If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service. * @enum {string|null} */ @@ -19074,7 +21887,10 @@ export interface components { }; /** PaymentLinksResourceCustomFieldsLabel */ payment_links_resource_custom_fields_label: { - /** @description Custom text for the label, displayed to the customer. Up to 50 characters. */ + /** + * @nullable + * @description Custom text for the label, displayed to the customer. Up to 50 characters. + */ custom?: string | null; /** * @description The type of the label. @@ -19084,27 +21900,51 @@ export interface components { }; /** PaymentLinksResourceCustomFieldsNumeric */ payment_links_resource_custom_fields_numeric: { - /** @description The maximum character length constraint for the customer's input. */ + /** + * @nullable + * @description The maximum character length constraint for the customer's input. + */ maximum_length?: number | null; - /** @description The minimum character length requirement for the customer's input. */ + /** + * @nullable + * @description The minimum character length requirement for the customer's input. + */ minimum_length?: number | null; }; /** PaymentLinksResourceCustomFieldsText */ payment_links_resource_custom_fields_text: { - /** @description The maximum character length constraint for the customer's input. */ + /** + * @nullable + * @description The maximum character length constraint for the customer's input. + */ maximum_length?: number | null; - /** @description The minimum character length requirement for the customer's input. */ + /** + * @nullable + * @description The minimum character length requirement for the customer's input. + */ minimum_length?: number | null; }; /** PaymentLinksResourceCustomText */ payment_links_resource_custom_text: { - /** @description Custom text that should be displayed after the payment confirmation button. */ + /** + * @nullable + * @description Custom text that should be displayed after the payment confirmation button. + */ after_submit?: components["schemas"]["payment_links_resource_custom_text_position"] | null; - /** @description Custom text that should be displayed alongside shipping address collection. */ + /** + * @nullable + * @description Custom text that should be displayed alongside shipping address collection. + */ shipping_address?: components["schemas"]["payment_links_resource_custom_text_position"] | null; - /** @description Custom text that should be displayed alongside the payment confirmation button. */ + /** + * @nullable + * @description Custom text that should be displayed alongside the payment confirmation button. + */ submit?: components["schemas"]["payment_links_resource_custom_text_position"] | null; - /** @description Custom text that should be displayed in place of the default terms of service agreement text. */ + /** + * @nullable + * @description Custom text that should be displayed in place of the default terms of service agreement text. + */ terms_of_service_acceptance?: components["schemas"]["payment_links_resource_custom_text_position"] | null; }; /** PaymentLinksResourceCustomTextPosition */ @@ -19116,51 +21956,89 @@ export interface components { payment_links_resource_invoice_creation: { /** @description Enable creating an invoice on successful payment. */ enabled: boolean; - /** @description Configuration for the invoice. Default invoice values will be used if unspecified. */ + /** + * @nullable + * @description Configuration for the invoice. Default invoice values will be used if unspecified. + */ invoice_data?: components["schemas"]["payment_links_resource_invoice_settings"] | null; }; /** PaymentLinksResourceInvoiceSettings */ payment_links_resource_invoice_settings: { - /** @description The account tax IDs associated with the invoice. */ + /** + * @nullable + * @description The account tax IDs associated with the invoice. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; - /** @description A list of up to 4 custom fields to be displayed on the invoice. */ + /** + * @nullable + * @description A list of up to 4 custom fields to be displayed on the invoice. + */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Footer to be displayed on the invoice. */ + /** + * @nullable + * @description Footer to be displayed on the invoice. + */ footer?: string | null; - /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + /** + * @nullable + * @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. + */ issuer?: components["schemas"]["connect_account_reference"] | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description Options for invoice PDF rendering. */ + /** + * @nullable + * @description Options for invoice PDF rendering. + */ rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; }; /** PaymentLinksResourcePaymentIntentData */ payment_links_resource_payment_intent_data: { /** + * @nullable * @description Indicates when the funds will be captured from the customer's account. * @enum {string|null} */ capture_method?: "automatic" | "automatic_async" | "manual" | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @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; }; /** + * @nullable * @description Indicates that you intend to make future payments with the payment method collected during checkout. * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; - /** @description For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. */ + /** + * @nullable + * @description For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. + */ statement_descriptor?: string | null; - /** @description For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. */ + /** + * @nullable + * @description For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. + */ statement_descriptor_suffix?: string | null; - /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ + /** + * @nullable + * @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. + */ transfer_group?: string | null; }; /** PaymentLinksResourcePaymentMethodReuseAgreement */ @@ -19196,16 +22074,25 @@ 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 for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. + */ description?: string | null; invoice_settings: components["schemas"]["payment_links_resource_subscription_data_invoice_settings"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. */ metadata: { [key: string]: string; }; - /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ + /** + * @nullable + * @description Integer representing the number of trial period days before the customer is charged for the first time. + */ trial_period_days?: number | null; - /** @description Settings related to subscription trials. */ + /** + * @nullable + * @description Settings related to subscription trials. + */ trial_settings?: components["schemas"]["subscriptions_trials_resource_trial_settings"] | null; }; /** PaymentLinksResourceSubscriptionDataInvoiceSettings */ @@ -19221,7 +22108,10 @@ export interface components { }; /** PaymentLinksResourceTransferData */ payment_links_resource_transfer_data: { - /** @description The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ + /** + * @nullable + * @description The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + */ amount?: number | null; /** @description The connected account receiving the transfer. */ destination: string | components["schemas"]["account"]; @@ -19256,11 +22146,14 @@ export interface components { card_present?: components["schemas"]["payment_method_card_present"]; cashapp?: components["schemas"]["payment_method_cashapp"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. */ + /** + * @nullable + * @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. + */ customer?: (string | components["schemas"]["customer"]) | null; customer_balance?: components["schemas"]["payment_method_customer_balance"]; eps?: components["schemas"]["payment_method_eps"]; @@ -19278,7 +22171,10 @@ export interface components { link?: components["schemas"]["payment_method_link"]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -19316,15 +22212,30 @@ export interface components { }; /** payment_method_acss_debit */ payment_method_acss_debit: { - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Institution number of the bank account. */ + /** + * @nullable + * @description Institution number of the bank account. + */ institution_number?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description Transit number of the bank account. */ + /** + * @nullable + * @description Transit number of the bank account. + */ transit_number?: string | null; }; /** payment_method_affirm */ @@ -19337,20 +22248,38 @@ export interface components { payment_method_amazon_pay: Record; /** payment_method_au_becs_debit */ payment_method_au_becs_debit: { - /** @description Six-digit number identifying bank and branch associated with this bank account. */ + /** + * @nullable + * @description Six-digit number identifying bank and branch associated with this bank account. + */ bsb_number?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; }; /** payment_method_bacs_debit */ payment_method_bacs_debit: { - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description Sort code of the bank account. (e.g., `10-20-30`) */ + /** + * @nullable + * @description Sort code of the bank account. (e.g., `10-20-30`) + */ sort_code?: string | null; }; /** payment_method_bancontact */ @@ -19366,17 +22295,27 @@ export interface components { payment_method_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand: string; - /** @description Checks on Card address and CVC if provided. */ + /** + * @nullable + * @description Checks on Card address and CVC if provided. + */ checks?: components["schemas"]["payment_method_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. */ + /** + * @nullable + * @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 The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. */ + /** + * @nullable + * @description The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. + */ display_brand?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* @@ -19384,75 +22323,141 @@ export interface components { fingerprint?: string | null; /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ funding: string; - /** @description Details of the original PaymentMethod that created this object. */ + /** + * @nullable + * @description Details of the original PaymentMethod that created this object. + */ generated_from?: components["schemas"]["payment_method_card_generated_card"] | null; /** @description The last four digits of the card. */ last4: string; - /** @description Contains information about card networks that can be used to process the payment. */ + /** + * @nullable + * @description Contains information about card networks that can be used to process the payment. + */ networks?: components["schemas"]["networks"] | null; /** + * @nullable * @description Status of a card based on the card issuer. * @enum {string|null} */ regulated_status?: "regulated" | "unregulated" | null; - /** @description Contains details on how this Card may be used for 3D Secure authentication. */ + /** + * @nullable + * @description Contains details on how this Card may be used for 3D Secure authentication. + */ three_d_secure_usage?: components["schemas"]["three_d_secure_usage"] | null; - /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ + /** + * @nullable + * @description If this Card is part of a card wallet, this contains the details of the card wallet. + */ wallet?: components["schemas"]["payment_method_card_wallet"] | null; }; /** payment_method_card_checks */ payment_method_card_checks: { - /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. + */ cvc_check?: string | null; }; /** payment_method_card_generated_card */ payment_method_card_generated_card: { - /** @description The charge that created this object. */ + /** + * @nullable + * @description The charge that created this object. + */ charge?: string | null; - /** @description Transaction-specific details of the payment method used in the payment. */ + /** + * @nullable + * @description Transaction-specific details of the payment method used in the payment. + */ payment_method_details?: components["schemas"]["card_generated_from_payment_method_details"] | null; - /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ + /** + * @nullable + * @description The ID of the SetupAttempt that generated this PaymentMethod, if any. + */ setup_attempt?: (string | components["schemas"]["setup_attempt"]) | null; }; /** payment_method_card_present */ payment_method_card_present: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ brand?: string | null; - /** @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ + /** + * @nullable + * @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. + */ brand_product?: string | null; - /** @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /** + * @nullable + * @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. + */ cardholder_name?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; - /** @description A high-level description of the type of cards issued in this range. */ + /** + * @nullable + * @description A high-level description of the type of cards issued in this range. + */ description?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description The name of the card's issuing bank. */ + /** + * @nullable + * @description The name of the card's issuing bank. + */ issuer?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Contains information about card networks that can be used to process the payment. */ + /** + * @nullable + * @description Contains information about card networks that can be used to process the payment. + */ networks?: components["schemas"]["payment_method_card_present_networks"] | null; - /** @description Details about payment methods collected offline. */ + /** + * @nullable + * @description Details about payment methods collected offline. + */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. + */ preferred_locales?: string[] | null; /** + * @nullable * @description How card details were read in this transaction. * @enum {string|null} */ @@ -19463,14 +22468,20 @@ export interface components { payment_method_card_present_networks: { /** @description All available networks for the card. */ available: string[]; - /** @description The preferred network for the card. */ + /** + * @nullable + * @description The preferred network for the card. + */ preferred?: string | null; }; /** payment_method_card_wallet */ payment_method_card_wallet: { amex_express_checkout?: components["schemas"]["payment_method_card_wallet_amex_express_checkout"]; apple_pay?: components["schemas"]["payment_method_card_wallet_apple_pay"]; - /** @description (For tokenized numbers only.) The last four digits of the device account number. */ + /** + * @nullable + * @description (For tokenized numbers only.) The last four digits of the device account number. + */ dynamic_last4?: string | null; google_pay?: components["schemas"]["payment_method_card_wallet_google_pay"]; link?: components["schemas"]["payment_method_card_wallet_link"]; @@ -19493,45 +22504,81 @@ export interface components { payment_method_card_wallet_link: Record; /** payment_method_card_wallet_masterpass */ payment_method_card_wallet_masterpass: { - /** @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ billing_address?: components["schemas"]["address"] | null; - /** @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ email?: string | null; - /** @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ name?: string | null; - /** @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ shipping_address?: components["schemas"]["address"] | null; }; /** payment_method_card_wallet_samsung_pay */ payment_method_card_wallet_samsung_pay: Record; /** payment_method_card_wallet_visa_checkout */ payment_method_card_wallet_visa_checkout: { - /** @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ billing_address?: components["schemas"]["address"] | null; - /** @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ email?: string | null; - /** @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ name?: string | null; - /** @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ shipping_address?: components["schemas"]["address"] | null; }; /** payment_method_cashapp */ payment_method_cashapp: { - /** @description A unique and immutable identifier assigned by Cash App to every buyer. */ + /** + * @nullable + * @description A unique and immutable identifier assigned by Cash App to every buyer. + */ buyer_id?: string | null; - /** @description A public identifier for buyers using Cash App. */ + /** + * @nullable + * @description A public identifier for buyers using Cash App. + */ cashtag?: string | null; }; /** PaymentMethodConfigBizPaymentMethodConfigurationDetails */ payment_method_config_biz_payment_method_configuration_details: { /** @description ID of the payment method configuration used. */ id: string; - /** @description ID of the parent payment method configuration used. */ + /** + * @nullable + * @description ID of the parent payment method configuration used. + */ parent?: string | null; }; /** PaymentMethodConfigResourceDisplayPreference */ payment_method_config_resource_display_preference: { - /** @description For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. */ + /** + * @nullable + * @description For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + */ overridable?: boolean | null; /** * @description The account's display preference. @@ -19577,7 +22624,10 @@ export interface components { alma?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; amazon_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; apple_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; - /** @description For child configs, the Connect application associated with the configuration. */ + /** + * @nullable + * @description For child configs, the Connect application associated with the configuration. + */ application?: string | null; au_becs_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; bacs_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -19615,7 +22665,10 @@ export interface components { object: "payment_method_configuration"; oxxo?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; p24?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; - /** @description For child configs, the configuration's parent configuration. */ + /** + * @nullable + * @description For child configs, the configuration's parent configuration. + */ parent?: string | null; pay_by_bank?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; paynow?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -19693,58 +22746,110 @@ export interface components { }; /** payment_method_details_ach_credit_transfer */ payment_method_details_ach_credit_transfer: { - /** @description Account number to transfer funds to. */ + /** + * @nullable + * @description Account number to transfer funds to. + */ account_number?: string | null; - /** @description Name of the bank associated with the routing number. */ + /** + * @nullable + * @description Name of the bank associated with the routing number. + */ bank_name?: string | null; - /** @description Routing transit number for the bank account to transfer funds to. */ + /** + * @nullable + * @description Routing transit number for the bank account to transfer funds to. + */ routing_number?: string | null; - /** @description SWIFT code of the bank associated with the routing number. */ + /** + * @nullable + * @description SWIFT code of the bank associated with the routing number. + */ swift_code?: string | null; }; /** payment_method_details_ach_debit */ payment_method_details_ach_debit: { /** + * @nullable * @description Type of entity that holds the account. This can be either `individual` or `company`. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description Routing transit number of the bank account. */ + /** + * @nullable + * @description Routing transit number of the bank account. + */ routing_number?: string | null; }; /** payment_method_details_acss_debit */ payment_method_details_acss_debit: { - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Institution number of the bank account */ + /** + * @nullable + * @description Institution number of the bank account + */ institution_number?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string; - /** @description Transit number of the bank account. */ + /** + * @nullable + * @description Transit number of the bank account. + */ transit_number?: string | null; }; /** payment_method_details_affirm */ payment_method_details_affirm: { - /** @description The Affirm transaction ID associated with this payment. */ + /** + * @nullable + * @description The Affirm transaction ID associated with this payment. + */ transaction_id?: string | null; }; /** payment_method_details_afterpay_clearpay */ payment_method_details_afterpay_clearpay: { - /** @description The Afterpay order ID associated with this payment intent. */ + /** + * @nullable + * @description The Afterpay order ID associated with this payment intent. + */ order_id?: string | null; - /** @description Order identifier shown to the merchant in Afterpay’s online portal. */ + /** + * @nullable + * @description Order identifier shown to the merchant in Afterpay’s online portal. + */ reference?: string | null; }; /** payment_method_details_alma */ @@ -19755,47 +22860,88 @@ export interface components { }; /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { - /** @description Bank-State-Branch number of the bank account. */ + /** + * @nullable + * @description Bank-State-Branch number of the bank account. + */ bsb_number?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string; }; /** payment_method_details_bacs_debit */ payment_method_details_bacs_debit: { - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description ID of the mandate used to make this payment. */ + /** + * @nullable + * @description ID of the mandate used to make this payment. + */ mandate?: string | null; - /** @description Sort code of the bank account. (e.g., `10-20-30`) */ + /** + * @nullable + * @description Sort code of the bank account. (e.g., `10-20-30`) + */ sort_code?: string | null; }; /** payment_method_details_bancontact */ payment_method_details_bancontact: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ preferred_language?: "de" | "en" | "fr" | "nl" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -19803,7 +22949,10 @@ export interface components { }; /** payment_method_details_blik */ payment_method_details_blik: { - /** @description A unique and immutable identifier assigned by BLIK to every buyer. */ + /** + * @nullable + * @description A unique and immutable identifier assigned by BLIK to every buyer. + */ buyer_id?: string | null; }; /** payment_method_details_boleto */ @@ -19813,20 +22962,35 @@ export interface components { }; /** payment_method_details_card */ payment_method_details_card: { - /** @description The authorized amount. */ + /** + * @nullable + * @description The authorized amount. + */ amount_authorized?: number | null; - /** @description Authorization code on the charge. */ + /** + * @nullable + * @description Authorization code on the charge. + */ authorization_code?: string | null; - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `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. + * @format unix-time */ capture_before?: number; - /** @description Check results by Card networks on Card address and CVC at time of payment. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ exp_month: number; @@ -19834,61 +22998,104 @@ export interface components { exp_year: number; extended_authorization?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization"]; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; incremental_authorization?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization"]; /** + * @nullable * @description Installment details for this payment (Mexico only). * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ installments?: components["schemas"]["payment_method_details_card_installments"] | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description ID of the mandate used to make this payment or created by it. */ + /** + * @nullable + * @description ID of the mandate used to make this payment or created by it. + */ mandate?: string | null; multicapture?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_multicapture"]; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ network?: string | null; - /** @description If this card has network token credentials, this contains the details of the network token credentials. */ + /** + * @nullable + * @description If this card has network token credentials, this contains the details of the network token credentials. + */ network_token?: components["schemas"]["payment_method_details_card_network_token"] | null; - /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** + * @nullable + * @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. + */ network_transaction_id?: string | null; overcapture?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"]; /** + * @nullable * @description Status of a card based on the card issuer. * @enum {string|null} */ regulated_status?: "regulated" | "unregulated" | null; - /** @description Populated if this transaction used 3D Secure authentication. */ + /** + * @nullable + * @description Populated if this transaction used 3D Secure authentication. + */ three_d_secure?: components["schemas"]["three_d_secure_details_charge"] | null; - /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ + /** + * @nullable + * @description If this Card is part of a card wallet, this contains the details of the card wallet. + */ wallet?: components["schemas"]["payment_method_details_card_wallet"] | null; }; /** payment_method_details_card_checks */ payment_method_details_card_checks: { - /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. + */ cvc_check?: string | null; }; /** payment_method_details_card_installments */ payment_method_details_card_installments: { - /** @description Installment plan selected for the payment. */ + /** + * @nullable + * @description Installment plan selected for the payment. + */ plan?: components["schemas"]["payment_method_details_card_installments_plan"] | null; }; /** payment_method_details_card_installments_plan */ payment_method_details_card_installments_plan: { - /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ + /** + * @nullable + * @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. + */ count?: number | null; /** + * @nullable * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. * One of `month`. * @enum {string|null} @@ -19907,72 +23114,124 @@ export interface components { }; /** payment_method_details_card_present */ payment_method_details_card_present: { - /** @description The authorized amount */ + /** + * @nullable + * @description The authorized amount + */ amount_authorized?: number | null; - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ brand?: string | null; - /** @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ + /** + * @nullable + * @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. + */ brand_product?: string | null; /** - * Format: unix-time * @description When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. + * @format unix-time */ capture_before?: number; - /** @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /** + * @nullable + * @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. + */ cardholder_name?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; - /** @description A high-level description of the type of cards issued in this range. */ + /** + * @nullable + * @description A high-level description of the type of cards issued in this range. + */ description?: string | null; - /** @description Authorization response cryptogram. */ + /** + * @nullable + * @description Authorization response cryptogram. + */ emv_auth_data?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ + /** + * @nullable + * @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. + */ generated_card?: string | null; /** @description Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). */ incremental_authorization_supported: boolean; - /** @description The name of the card's issuing bank. */ + /** + * @nullable + * @description The name of the card's issuing bank. + */ issuer?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ network?: string | null; - /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** + * @nullable + * @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. + */ network_transaction_id?: string | null; - /** @description Details about payments collected offline. */ + /** + * @nullable + * @description Details about payments collected offline. + */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; /** @description Defines whether the authorized amount can be over-captured or not */ overcapture_supported: boolean; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. + */ preferred_locales?: string[] | null; /** + * @nullable * @description How card details were read in this transaction. * @enum {string|null} */ read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; - /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ + /** + * @nullable + * @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. + */ receipt?: components["schemas"]["payment_method_details_card_present_receipt"] | null; wallet?: components["schemas"]["payment_flows_private_payment_methods_card_present_common_wallet"]; }; /** payment_method_details_card_present_offline */ payment_method_details_card_present_offline: { /** - * Format: unix-time + * @nullable * @description Time at which the payment was collected while offline + * @format unix-time */ stored_at?: number | null; /** + * @nullable * @description The method used to process this payment method offline. Only deferred is allowed. * @enum {string|null} */ @@ -19985,28 +23244,55 @@ export interface components { * @enum {string} */ account_type?: "checking" | "credit" | "prepaid" | "unknown"; - /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. + */ application_cryptogram?: string | null; - /** @description Mnenomic of the Application Identifier. */ + /** + * @nullable + * @description Mnenomic of the Application Identifier. + */ application_preferred_name?: string | null; - /** @description Identifier for this transaction. */ + /** + * @nullable + * @description Identifier for this transaction. + */ authorization_code?: string | null; - /** @description EMV tag 8A. A code returned by the card issuer. */ + /** + * @nullable + * @description EMV tag 8A. A code returned by the card issuer. + */ authorization_response_code?: string | null; - /** @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ + /** + * @nullable + * @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. + */ cardholder_verification_method?: string | null; - /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. + */ dedicated_file_name?: string | null; - /** @description The outcome of a series of EMV functions performed by the card reader. */ + /** + * @nullable + * @description The outcome of a series of EMV functions performed by the card reader. + */ terminal_verification_results?: string | null; - /** @description An indication of various EMV functions performed during the transaction. */ + /** + * @nullable + * @description An indication of various EMV functions performed during the transaction. + */ transaction_status_information?: string | null; }; /** payment_method_details_card_wallet */ payment_method_details_card_wallet: { amex_express_checkout?: components["schemas"]["payment_method_details_card_wallet_amex_express_checkout"]; apple_pay?: components["schemas"]["payment_method_details_card_wallet_apple_pay"]; - /** @description (For tokenized numbers only.) The last four digits of the device account number. */ + /** + * @nullable + * @description (For tokenized numbers only.) The last four digits of the device account number. + */ dynamic_last4?: string | null; google_pay?: components["schemas"]["payment_method_details_card_wallet_google_pay"]; link?: components["schemas"]["payment_method_details_card_wallet_link"]; @@ -20029,33 +23315,63 @@ export interface components { payment_method_details_card_wallet_link: Record; /** payment_method_details_card_wallet_masterpass */ payment_method_details_card_wallet_masterpass: { - /** @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ billing_address?: components["schemas"]["address"] | null; - /** @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ email?: string | null; - /** @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ name?: string | null; - /** @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ shipping_address?: components["schemas"]["address"] | null; }; /** payment_method_details_card_wallet_samsung_pay */ payment_method_details_card_wallet_samsung_pay: Record; /** payment_method_details_card_wallet_visa_checkout */ payment_method_details_card_wallet_visa_checkout: { - /** @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ billing_address?: components["schemas"]["address"] | null; - /** @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ email?: string | null; - /** @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ name?: string | null; - /** @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ shipping_address?: components["schemas"]["address"] | null; }; /** payment_method_details_cashapp */ payment_method_details_cashapp: { - /** @description A unique and immutable identifier assigned by Cash App to every buyer. */ + /** + * @nullable + * @description A unique and immutable identifier assigned by Cash App to every buyer. + */ buyer_id?: string | null; - /** @description A public identifier for buyers using Cash App. */ + /** + * @nullable + * @description A public identifier for buyers using Cash App. + */ cashtag?: string | null; }; /** payment_method_details_customer_balance */ @@ -20063,11 +23379,13 @@ export interface components { /** payment_method_details_eps */ payment_method_details_eps: { /** + * @nullable * @description The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. * @enum {string|null} */ bank?: "arzte_und_apotheker_bank" | "austrian_anadi_bank_ag" | "bank_austria" | "bankhaus_carl_spangler" | "bankhaus_schelhammer_und_schattera_ag" | "bawag_psk_ag" | "bks_bank_ag" | "brull_kallmus_bank_ag" | "btv_vier_lander_bank" | "capital_bank_grawe_gruppe_ag" | "deutsche_bank_ag" | "dolomitenbank" | "easybank_ag" | "erste_bank_und_sparkassen" | "hypo_alpeadriabank_international_ag" | "hypo_bank_burgenland_aktiengesellschaft" | "hypo_noe_lb_fur_niederosterreich_u_wien" | "hypo_oberosterreich_salzburg_steiermark" | "hypo_tirol_bank_ag" | "hypo_vorarlberg_bank_ag" | "marchfelder_bank" | "oberbank_ag" | "raiffeisen_bankengruppe_osterreich" | "schoellerbank_ag" | "sparda_bank_wien" | "volksbank_gruppe" | "volkskreditbank_ag" | "vr_bank_braunau" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by EPS directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * EPS rarely provides this information so the attribute is usually empty. @@ -20081,18 +23399,31 @@ export interface components { * @enum {string} */ bank: "affin_bank" | "agrobank" | "alliance_bank" | "ambank" | "bank_islam" | "bank_muamalat" | "bank_of_china" | "bank_rakyat" | "bsn" | "cimb" | "deutsche_bank" | "hong_leong_bank" | "hsbc" | "kfh" | "maybank2e" | "maybank2u" | "ocbc" | "pb_enterprise" | "public_bank" | "rhb" | "standard_chartered" | "uob"; - /** @description Unique transaction id generated by FPX for every request from the merchant */ + /** + * @nullable + * @description Unique transaction id generated by FPX for every request from the merchant + */ transaction_id?: string | null; }; /** payment_method_details_giropay */ payment_method_details_giropay: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Giropay directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Giropay rarely provides this information so the attribute is usually empty. @@ -20101,28 +23432,43 @@ export interface components { }; /** payment_method_details_grabpay */ payment_method_details_grabpay: { - /** @description Unique transaction id generated by GrabPay */ + /** + * @nullable + * @description Unique transaction id generated by GrabPay + */ transaction_id?: string | null; }; /** payment_method_details_ideal */ payment_method_details_ideal: { /** + * @nullable * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; /** + * @nullable * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -20130,46 +23476,87 @@ export interface components { }; /** payment_method_details_interac_present */ payment_method_details_interac_present: { - /** @description Card brand. Can be `interac`, `mastercard` or `visa`. */ + /** + * @nullable + * @description Card brand. Can be `interac`, `mastercard` or `visa`. + */ brand?: string | null; - /** @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /** + * @nullable + * @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. + */ cardholder_name?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; - /** @description A high-level description of the type of cards issued in this range. */ + /** + * @nullable + * @description A high-level description of the type of cards issued in this range. + */ description?: string | null; - /** @description Authorization response cryptogram. */ + /** + * @nullable + * @description Authorization response cryptogram. + */ emv_auth_data?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ + /** + * @nullable + * @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. + */ generated_card?: string | null; - /** @description The name of the card's issuing bank. */ + /** + * @nullable + * @description The name of the card's issuing bank. + */ issuer?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ network?: string | null; - /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** + * @nullable + * @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. + */ network_transaction_id?: string | null; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. + */ preferred_locales?: string[] | null; /** + * @nullable * @description How card details were read in this transaction. * @enum {string|null} */ read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; - /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ + /** + * @nullable + * @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. + */ receipt?: components["schemas"]["payment_method_details_interac_present_receipt"] | null; }; /** payment_method_details_interac_present_receipt */ @@ -20179,38 +23566,70 @@ export interface components { * @enum {string} */ account_type?: "checking" | "savings" | "unknown"; - /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. + */ application_cryptogram?: string | null; - /** @description Mnenomic of the Application Identifier. */ + /** + * @nullable + * @description Mnenomic of the Application Identifier. + */ application_preferred_name?: string | null; - /** @description Identifier for this transaction. */ + /** + * @nullable + * @description Identifier for this transaction. + */ authorization_code?: string | null; - /** @description EMV tag 8A. A code returned by the card issuer. */ + /** + * @nullable + * @description EMV tag 8A. A code returned by the card issuer. + */ authorization_response_code?: string | null; - /** @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ + /** + * @nullable + * @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. + */ cardholder_verification_method?: string | null; - /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. + */ dedicated_file_name?: string | null; - /** @description The outcome of a series of EMV functions performed by the card reader. */ + /** + * @nullable + * @description The outcome of a series of EMV functions performed by the card reader. + */ terminal_verification_results?: string | null; - /** @description An indication of various EMV functions performed during the transaction. */ + /** + * @nullable + * @description An indication of various EMV functions performed during the transaction. + */ transaction_status_information?: string | null; }; /** payment_method_details_kakao_pay */ payment_method_details_kakao_pay: { - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; }; /** payment_method_details_klarna */ payment_method_details_klarna: { - /** @description The payer details for this transaction. */ + /** + * @nullable + * @description The payer details for this transaction. + */ payer_details?: components["schemas"]["klarna_payer_details"] | null; /** + * @nullable * @description The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` */ payment_method_category?: string | null; /** + * @nullable * @description Preferred language of the Klarna authorization page that the customer is redirected to. * Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH` */ @@ -20218,12 +23637,16 @@ export interface components { }; /** payment_method_details_konbini */ payment_method_details_konbini: { - /** @description If the payment succeeded, this contains the details of the convenience store where the payment was completed. */ + /** + * @nullable + * @description If the payment succeeded, this contains the details of the convenience store where the payment was completed. + */ store?: components["schemas"]["payment_method_details_konbini_store"] | null; }; /** payment_method_details_konbini_store */ payment_method_details_konbini_store: { /** + * @nullable * @description The name of the convenience store chain where the payment was completed. * @enum {string|null} */ @@ -20232,18 +23655,26 @@ export interface components { /** payment_method_details_kr_card */ payment_method_details_kr_card: { /** + * @nullable * @description The local credit or debit card brand. * @enum {string|null} */ brand?: "bc" | "citi" | "hana" | "hyundai" | "jeju" | "jeonbuk" | "kakaobank" | "kbank" | "kdbbank" | "kookmin" | "kwangju" | "lotte" | "mg" | "nh" | "post" | "samsung" | "savingsbank" | "shinhan" | "shinhyup" | "suhyup" | "tossbank" | "woori" | null; - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; - /** @description The last four digits of the card. This may not be present for American Express cards. */ + /** + * @nullable + * @description The last four digits of the card. This may not be present for American Express cards. + */ last4?: string | null; }; /** payment_method_details_link */ payment_method_details_link: { /** + * @nullable * @description Two-letter ISO code representing the funding source country beneath the Link payment. * You could use this attribute to get a sense of international fees. */ @@ -20251,36 +23682,56 @@ export interface components { }; /** payment_method_details_mobilepay */ payment_method_details_mobilepay: { - /** @description Internal card details */ + /** + * @nullable + * @description Internal card details + */ card?: components["schemas"]["internal_card"] | null; }; /** payment_method_details_multibanco */ payment_method_details_multibanco: { - /** @description Entity number associated with this Multibanco payment. */ + /** + * @nullable + * @description Entity number associated with this Multibanco payment. + */ entity?: string | null; - /** @description Reference number associated with this Multibanco payment. */ + /** + * @nullable + * @description Reference number associated with this Multibanco payment. + */ reference?: string | null; }; /** payment_method_details_naver_pay */ payment_method_details_naver_pay: { - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; }; /** payment_method_details_oxxo */ payment_method_details_oxxo: { - /** @description OXXO reference number */ + /** + * @nullable + * @description OXXO reference number + */ number?: string | null; }; /** payment_method_details_p24 */ payment_method_details_p24: { /** + * @nullable * @description The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. * @enum {string|null} */ bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank" | null; - /** @description Unique reference for this Przelewy24 payment. */ + /** + * @nullable + * @description Unique reference for this Przelewy24 payment. + */ reference?: string | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Przelewy24 directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Przelewy24 rarely provides this information so the attribute is usually empty. @@ -20289,60 +23740,104 @@ export interface components { }; /** payment_method_details_passthrough_card */ payment_method_details_passthrough_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ brand?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @description Two-digit number representing the card's expiration month. + */ exp_month?: number | null; - /** @description Four-digit number representing the card's expiration year. */ + /** + * @nullable + * @description Four-digit number representing the card's expiration year. + */ exp_year?: number | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; }; /** payment_method_details_pay_by_bank */ payment_method_details_pay_by_bank: Record; /** payment_method_details_payco */ payment_method_details_payco: { - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; }; /** payment_method_details_paynow */ payment_method_details_paynow: { - /** @description Reference number associated with this PayNow payment */ + /** + * @nullable + * @description Reference number associated with this PayNow payment + */ reference?: string | null; }; /** payment_method_details_paypal */ payment_method_details_paypal: { - /** @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ country?: string | null; /** + * @nullable * @description Owner's email. Values are provided by PayPal directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ payer_email?: string | null; - /** @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ + /** + * @nullable + * @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. + */ payer_id?: string | null; /** + * @nullable * @description Owner's full name. Values provided by PayPal directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ payer_name?: string | null; - /** @description The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction. */ + /** + * @nullable + * @description The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction. + */ seller_protection?: components["schemas"]["paypal_seller_protection"] | null; - /** @description A unique ID generated by PayPal for this transaction. */ + /** + * @nullable + * @description A unique ID generated by PayPal for this transaction. + */ transaction_id?: string | null; }; /** payment_method_details_pix */ payment_method_details_pix: { - /** @description Unique transaction id generated by BCB */ + /** + * @nullable + * @description Unique transaction id generated by BCB + */ bank_transaction_id?: string | null; }; /** payment_method_details_promptpay */ payment_method_details_promptpay: { - /** @description Bill reference generated by PromptPay */ + /** + * @nullable + * @description Bill reference generated by PromptPay + */ reference?: string | null; }; /** payment_method_details_revolut_pay */ @@ -20351,47 +23846,91 @@ export interface components { }; /** payment_method_details_samsung_pay */ payment_method_details_samsung_pay: { - /** @description A unique identifier for the buyer as determined by the local payment processor. */ + /** + * @nullable + * @description A unique identifier for the buyer as determined by the local payment processor. + */ buyer_id?: string | null; }; /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Branch code of bank associated with the bank account. */ + /** + * @nullable + * @description Branch code of bank associated with the bank account. + */ branch_code?: string | null; - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ last4?: string | null; - /** @description Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve). */ + /** + * @nullable + * @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 */ payment_method_details_sofort: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` * @enum {string|null} */ preferred_language?: "de" | "en" | "es" | "fr" | "it" | "nl" | "pl" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by SOFORT directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -20401,11 +23940,20 @@ export interface components { payment_method_details_stripe_account: Record; /** payment_method_details_swish */ payment_method_details_swish: { - /** @description Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer */ + /** + * @nullable + * @description Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer + */ fingerprint?: string | null; - /** @description Payer bank reference number for the payment */ + /** + * @nullable + * @description Payer bank reference number for the payment + */ payment_reference?: string | null; - /** @description The last four digits of the Swish account phone number */ + /** + * @nullable + * @description The last four digits of the Swish account phone number + */ verified_phone_last4?: string | null; }; /** payment_method_details_twint */ @@ -20413,35 +23961,58 @@ export interface components { /** payment_method_details_us_bank_account */ payment_method_details_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; - /** @description Reference number to locate ACH payments with customer's bank. */ + /** + * @nullable + * @description Reference number to locate ACH payments with customer's bank. + */ payment_reference?: string | null; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; }; /** payment_method_details_wechat */ payment_method_details_wechat: Record; /** payment_method_details_wechat_pay */ payment_method_details_wechat_pay: { - /** @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. + */ fingerprint?: string | null; - /** @description Transaction ID of this particular WeChat Pay transaction. */ + /** + * @nullable + * @description Transaction ID of this particular WeChat Pay transaction. + */ transaction_id?: string | null; }; /** payment_method_details_zip */ @@ -20457,8 +24028,8 @@ export interface components { amazon_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"]; apple_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The domain name that this payment method domain object represents. */ @@ -20501,6 +24072,7 @@ export interface components { /** payment_method_eps */ payment_method_eps: { /** + * @nullable * @description The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. * @enum {string|null} */ @@ -20521,11 +24093,13 @@ export interface components { /** payment_method_ideal */ payment_method_ideal: { /** + * @nullable * @description The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; /** + * @nullable * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string|null} */ @@ -20533,35 +24107,64 @@ export interface components { }; /** payment_method_interac_present */ payment_method_interac_present: { - /** @description Card brand. Can be `interac`, `mastercard` or `visa`. */ + /** + * @nullable + * @description Card brand. Can be `interac`, `mastercard` or `visa`. + */ brand?: string | null; - /** @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /** + * @nullable + * @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. + */ cardholder_name?: string | null; - /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. + */ country?: string | null; - /** @description A high-level description of the type of cards issued in this range. */ + /** + * @nullable + * @description A high-level description of the type of cards issued in this range. + */ description?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ exp_year: number; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description The name of the card's issuing bank. */ + /** + * @nullable + * @description The name of the card's issuing bank. + */ issuer?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Contains information about card networks that can be used to process the payment. */ + /** + * @nullable + * @description Contains information about card networks that can be used to process the payment. + */ networks?: components["schemas"]["payment_method_card_present_networks"] | null; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** + * @nullable + * @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. + */ preferred_locales?: string[] | null; /** + * @nullable * @description How card details were read in this transaction. * @enum {string|null} */ @@ -20571,7 +24174,10 @@ export interface components { payment_method_kakao_pay: Record; /** payment_method_klarna */ payment_method_klarna: { - /** @description The customer's date of birth, if provided. */ + /** + * @nullable + * @description The customer's date of birth, if provided. + */ dob?: components["schemas"]["payment_flows_private_payment_methods_klarna_dob"] | null; }; /** payment_method_konbini */ @@ -20579,16 +24185,23 @@ export interface components { /** payment_method_kr_card */ payment_method_kr_card: { /** + * @nullable * @description The local credit or debit card brand. * @enum {string|null} */ brand?: "bc" | "citi" | "hana" | "hyundai" | "jeju" | "jeonbuk" | "kakaobank" | "kbank" | "kdbbank" | "kookmin" | "kwangju" | "lotte" | "mg" | "nh" | "post" | "samsung" | "savingsbank" | "shinhan" | "shinhyup" | "suhyup" | "tossbank" | "woori" | null; - /** @description The last four digits of the card. This may not be present for American Express cards. */ + /** + * @nullable + * @description The last four digits of the card. This may not be present for American Express cards. + */ last4?: string | null; }; /** payment_method_link */ payment_method_link: { - /** @description Account owner's email address. */ + /** + * @nullable + * @description Account owner's email address. + */ email?: string | null; }; /** payment_method_mobilepay */ @@ -20632,6 +24245,7 @@ export interface components { */ capture_method?: "manual"; /** + * @nullable * @description An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. * This field differs from the statement descriptor and item name. */ @@ -20726,11 +24340,17 @@ export interface components { }; /** payment_method_options_card_installments */ payment_method_options_card_installments: { - /** @description Installment plans that may be selected for this PaymentIntent. */ + /** + * @nullable + * @description Installment plans that may be selected for this PaymentIntent. + */ available_plans?: components["schemas"]["payment_method_details_card_installments_plan"][] | null; /** @description Whether Installments are enabled for this PaymentIntent. */ enabled: boolean; - /** @description Installment plan selected for this PaymentIntent. */ + /** + * @nullable + * @description Installment plan selected for this PaymentIntent. + */ plan?: components["schemas"]["payment_method_details_card_installments_plan"] | null; }; /** payment_method_options_card_mandate_options */ @@ -20742,11 +24362,15 @@ export interface components { * @enum {string} */ amount_type: "fixed" | "maximum"; - /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ + /** + * @nullable + * @description A description of the mandate or subscription that is meant to be displayed to the customer. + */ description?: string | null; /** - * Format: unix-time + * @nullable * @description End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. + * @format unix-time */ end_date?: number | null; /** @@ -20754,29 +24378,42 @@ export interface components { * @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; - /** @description The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. */ + /** + * @nullable + * @description The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. + */ interval_count?: number | null; /** @description Unique identifier for the mandate or subscription. */ reference: string; /** - * Format: unix-time * @description Start date of the mandate or subscription. Start date should not be lesser than yesterday. + * @format unix-time */ start_date: number; - /** @description Specifies the type of mandates supported. Possible values are `india`. */ + /** + * @nullable + * @description Specifies the type of mandates supported. Possible values are `india`. + */ supported_types?: "india"[] | null; }; /** payment_method_options_card_present */ payment_method_options_card_present: { - /** @description Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) */ + /** + * @nullable + * @description Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) + */ request_extended_authorization?: boolean | null; - /** @description Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. */ + /** + * @nullable + * @description Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. + */ request_incremental_authorization_support?: boolean | null; routing?: components["schemas"]["payment_method_options_card_present_routing"]; }; /** payment_method_options_card_present_routing */ payment_method_options_card_present_routing: { /** + * @nullable * @description Requested routing priority * @enum {string|null} */ @@ -20805,6 +24442,7 @@ export interface components { payment_method_options_customer_balance: { bank_transfer?: components["schemas"]["payment_method_options_customer_balance_bank_transfer"]; /** + * @nullable * @description The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. * @enum {string|null} */ @@ -20831,6 +24469,7 @@ export interface components { */ requested_address_types?: ("aba" | "iban" | "sepa" | "sort_code" | "spei" | "swift" | "zengin")[]; /** + * @nullable * @description The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. * @enum {string|null} */ @@ -20909,7 +24548,10 @@ export interface components { * @enum {string} */ capture_method?: "manual"; - /** @description Preferred locale of the Klarna checkout page that the customer is redirected to. */ + /** + * @nullable + * @description Preferred locale of the Klarna checkout page that the customer is redirected to. + */ preferred_locale?: string | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -20925,16 +24567,26 @@ export interface components { }; /** payment_method_options_konbini */ payment_method_options_konbini: { - /** @description An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. */ + /** + * @nullable + * @description An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. + */ confirmation_number?: string | null; - /** @description The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. */ + /** + * @nullable + * @description The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. + */ expires_after_days?: number | null; /** - * Format: unix-time + * @nullable * @description The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set. + * @format unix-time */ expires_at?: number | null; - /** @description A product descriptor of up to 22 characters, which will appear to customers at the convenience store. */ + /** + * @nullable + * @description A product descriptor of up to 22 characters, which will appear to customers at the convenience store. + */ product_description?: string | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -21034,9 +24686,15 @@ export interface components { * @enum {string} */ capture_method?: "manual"; - /** @description Preferred locale of the PayPal checkout page that the customer is redirected to. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. @@ -21052,9 +24710,15 @@ export interface components { }; /** payment_method_options_pix */ payment_method_options_pix: { - /** @description The number of seconds (between 10 and 1209600) after which Pix payment will expire. */ + /** + * @nullable + * @description The number of seconds (between 10 and 1209600) after which Pix payment will expire. + */ expires_after_seconds?: number | null; - /** @description The timestamp at which the Pix expires. */ + /** + * @nullable + * @description The timestamp at which the Pix expires. + */ expires_at?: number | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -21104,6 +24768,7 @@ export interface components { /** payment_method_options_sofort */ payment_method_options_sofort: { /** + * @nullable * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * @enum {string|null} */ @@ -21144,9 +24809,13 @@ export interface components { }; /** payment_method_options_wechat_pay */ payment_method_options_wechat_pay: { - /** @description The app ID registered with WeChat Pay. Only required when client is ios or android. */ + /** + * @nullable + * @description The app ID registered with WeChat Pay. Only required when client is ios or android. + */ app_id?: string | null; /** + * @nullable * @description The client type that the end customer will pay from * @enum {string|null} */ @@ -21182,6 +24851,7 @@ export interface components { /** payment_method_p24 */ payment_method_p24: { /** + * @nullable * @description The customer's bank, if provided. * @enum {string|null} */ @@ -21195,14 +24865,21 @@ export interface components { payment_method_paynow: Record; /** payment_method_paypal */ payment_method_paypal: { - /** @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ country?: string | null; /** + * @nullable * @description Owner's email. Values are provided by PayPal directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ payer_email?: string | null; - /** @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ + /** + * @nullable + * @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. + */ payer_id?: string | null; }; /** payment_method_pix */ @@ -21215,22 +24892,43 @@ export interface components { payment_method_samsung_pay: Record; /** payment_method_sepa_debit */ payment_method_sepa_debit: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Branch code of bank associated with the bank account. */ + /** + * @nullable + * @description Branch code of bank associated with the bank account. + */ branch_code?: string | null; - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Information about the object that generated this PaymentMethod. */ + /** + * @nullable + * @description Information about the object that generated this PaymentMethod. + */ generated_from?: components["schemas"]["sepa_debit_generated_from"] | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ last4?: string | null; }; /** payment_method_sofort */ payment_method_sofort: { - /** @description Two-letter ISO code representing the country the bank account is located in. */ + /** + * @nullable + * @description Two-letter ISO code representing the country the bank account is located in. + */ country?: string | null; }; /** payment_method_swish */ @@ -21240,38 +24938,63 @@ export interface components { /** payment_method_us_bank_account */ payment_method_us_bank_account: { /** + * @nullable * @description Account holder type: individual or company. * @enum {string|null} */ account_holder_type?: "company" | "individual" | null; /** + * @nullable * @description Account type: checkings or savings. Defaults to checking if omitted. * @enum {string|null} */ account_type?: "checking" | "savings" | null; - /** @description The name of the bank. */ + /** + * @nullable + * @description The name of the bank. + */ bank_name?: string | null; - /** @description The ID of the Financial Connections Account used to create the payment method. */ + /** + * @nullable + * @description The ID of the Financial Connections Account used to create the payment method. + */ financial_connections_account?: string | null; - /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /** + * @nullable + * @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. + */ fingerprint?: string | null; - /** @description Last four digits of the bank account number. */ + /** + * @nullable + * @description Last four digits of the bank account number. + */ last4?: string | null; - /** @description Contains information about US bank account networks that can be used. */ + /** + * @nullable + * @description Contains information about US bank account networks that can be used. + */ networks?: components["schemas"]["us_bank_account_networks"] | null; - /** @description Routing number of the bank account. */ + /** + * @nullable + * @description Routing number of the bank account. + */ routing_number?: string | null; - /** @description Contains information about the future reusability of this PaymentMethod. */ + /** + * @nullable + * @description Contains information about the future reusability of this PaymentMethod. + */ status_details?: components["schemas"]["payment_method_us_bank_account_status_details"] | null; }; /** payment_method_us_bank_account_blocked */ payment_method_us_bank_account_blocked: { /** + * @nullable * @description The ACH network code that resulted in this block. * @enum {string|null} */ network_code?: "R02" | "R03" | "R04" | "R05" | "R07" | "R08" | "R10" | "R11" | "R16" | "R20" | "R29" | "R31" | null; /** + * @nullable * @description The reason why this PaymentMethod's fingerprint has been blocked * @enum {string|null} */ @@ -21292,7 +25015,10 @@ export interface components { }; /** PaymentPagesCheckoutSessionAfterExpiration */ payment_pages_checkout_session_after_expiration: { - /** @description When set, configuration used to recover the Checkout Session on expiry. */ + /** + * @nullable + * @description When set, configuration used to recover the Checkout Session on expiry. + */ recovery?: components["schemas"]["payment_pages_checkout_session_after_expiration_recovery"] | null; }; /** PaymentPagesCheckoutSessionAfterExpirationRecovery */ @@ -21306,20 +25032,28 @@ export interface components { */ enabled: boolean; /** - * Format: unix-time + * @nullable * @description The timestamp at which the recovery URL will expire. + * @format unix-time */ expires_at?: number | null; - /** @description URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session */ + /** + * @nullable + * @description URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session + */ url?: string | null; }; /** PaymentPagesCheckoutSessionAutomaticTax */ payment_pages_checkout_session_automatic_tax: { /** @description Indicates whether automatic tax is enabled for the session */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; /** + * @nullable * @description The status of the most recent automated tax calculation for this session. * @enum {string|null} */ @@ -21328,12 +25062,14 @@ export interface components { /** PaymentPagesCheckoutSessionConsent */ payment_pages_checkout_session_consent: { /** + * @nullable * @description If `opt_in`, the customer consents to receiving promotional communications * from the merchant about this Checkout Session. * @enum {string|null} */ promotions?: "opt_in" | "opt_out" | null; /** + * @nullable * @description If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service. * @enum {string|null} */ @@ -21341,9 +25077,13 @@ export interface components { }; /** PaymentPagesCheckoutSessionConsentCollection */ payment_pages_checkout_session_consent_collection: { - /** @description If set to `hidden`, it will hide legal text related to the reuse of a payment method. */ + /** + * @nullable + * @description If set to `hidden`, it will hide legal text related to the reuse of a payment method. + */ payment_method_reuse_agreement?: components["schemas"]["payment_pages_checkout_session_payment_method_reuse_agreement"] | null; /** + * @nullable * @description If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout * Session will determine whether to display an option to opt into promotional communication * from the merchant depending on the customer's locale. Only available to US merchants. @@ -21351,6 +25091,7 @@ export interface components { */ promotions?: "auto" | "none" | null; /** + * @nullable * @description If set to `required`, it requires customers to accept the terms of service before being able to pay. * @enum {string|null} */ @@ -21363,8 +25104,8 @@ export interface components { /** @description Total of all items in source currency after discounts and taxes are applied. */ amount_total: number; /** - * Format: decimal * @description Exchange rate used to convert source currency amounts to customer currency amounts + * @format decimal */ fx_rate: string; /** @description Creation currency of the CheckoutSession before localization */ @@ -21388,16 +25129,25 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFieldsDropdown */ payment_pages_checkout_session_custom_fields_dropdown: { - /** @description The value that will pre-fill on the payment page. */ + /** + * @nullable + * @description The value that will pre-fill on the payment page. + */ default_value?: string | null; /** @description The options available for the customer to select. Up to 200 options allowed. */ options: components["schemas"]["payment_pages_checkout_session_custom_fields_option"][]; - /** @description The option selected by the customer. This will be the `value` for the option. */ + /** + * @nullable + * @description The option selected by the customer. This will be the `value` for the option. + */ value?: string | null; }; /** PaymentPagesCheckoutSessionCustomFieldsLabel */ payment_pages_checkout_session_custom_fields_label: { - /** @description Custom text for the label, displayed to the customer. Up to 50 characters. */ + /** + * @nullable + * @description Custom text for the label, displayed to the customer. Up to 50 characters. + */ custom?: string | null; /** * @description The type of the label. @@ -21407,13 +25157,25 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFieldsNumeric */ payment_pages_checkout_session_custom_fields_numeric: { - /** @description The value that will pre-fill the field on the payment page. */ + /** + * @nullable + * @description The value that will pre-fill the field on the payment page. + */ default_value?: string | null; - /** @description The maximum character length constraint for the customer's input. */ + /** + * @nullable + * @description The maximum character length constraint for the customer's input. + */ maximum_length?: number | null; - /** @description The minimum character length requirement for the customer's input. */ + /** + * @nullable + * @description The minimum character length requirement for the customer's input. + */ minimum_length?: number | null; - /** @description The value entered by the customer, containing only digits. */ + /** + * @nullable + * @description The value entered by the customer, containing only digits. + */ value?: string | null; }; /** PaymentPagesCheckoutSessionCustomFieldsOption */ @@ -21425,24 +25187,48 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFieldsText */ payment_pages_checkout_session_custom_fields_text: { - /** @description The value that will pre-fill the field on the payment page. */ + /** + * @nullable + * @description The value that will pre-fill the field on the payment page. + */ default_value?: string | null; - /** @description The maximum character length constraint for the customer's input. */ + /** + * @nullable + * @description The maximum character length constraint for the customer's input. + */ maximum_length?: number | null; - /** @description The minimum character length requirement for the customer's input. */ + /** + * @nullable + * @description The minimum character length requirement for the customer's input. + */ minimum_length?: number | null; - /** @description The value entered by the customer. */ + /** + * @nullable + * @description The value entered by the customer. + */ value?: string | null; }; /** PaymentPagesCheckoutSessionCustomText */ payment_pages_checkout_session_custom_text: { - /** @description Custom text that should be displayed after the payment confirmation button. */ + /** + * @nullable + * @description Custom text that should be displayed after the payment confirmation button. + */ after_submit?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; - /** @description Custom text that should be displayed alongside shipping address collection. */ + /** + * @nullable + * @description Custom text that should be displayed alongside shipping address collection. + */ shipping_address?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; - /** @description Custom text that should be displayed alongside the payment confirmation button. */ + /** + * @nullable + * @description Custom text that should be displayed alongside the payment confirmation button. + */ submit?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; - /** @description Custom text that should be displayed in place of the default terms of service agreement text. */ + /** + * @nullable + * @description Custom text that should be displayed in place of the default terms of service agreement text. + */ terms_of_service_acceptance?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; }; /** PaymentPagesCheckoutSessionCustomTextPosition */ @@ -21452,30 +25238,50 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomerDetails */ payment_pages_checkout_session_customer_details: { - /** @description The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. */ + /** + * @nullable + * @description The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. + */ address?: components["schemas"]["address"] | null; /** + * @nullable * @description The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry. * Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form. */ email?: string | null; - /** @description The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. */ + /** + * @nullable + * @description The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. + */ name?: string | null; - /** @description The customer's phone number after a completed Checkout Session. */ + /** + * @nullable + * @description The customer's phone number after a completed Checkout Session. + */ phone?: string | null; /** + * @nullable * @description The customer’s tax exempt status after a completed Checkout Session. * @enum {string|null} */ tax_exempt?: "exempt" | "none" | "reverse" | null; - /** @description The customer’s tax IDs after a completed Checkout Session. */ + /** + * @nullable + * @description The customer’s tax IDs after a completed Checkout Session. + */ tax_ids?: components["schemas"]["payment_pages_checkout_session_tax_id"][] | null; }; /** PaymentPagesCheckoutSessionDiscount */ payment_pages_checkout_session_discount: { - /** @description Coupon attached to the Checkout Session. */ + /** + * @nullable + * @description Coupon attached to the Checkout Session. + */ coupon?: (string | components["schemas"]["coupon"]) | null; - /** @description Promotion code attached to the Checkout Session. */ + /** + * @nullable + * @description Promotion code attached to the Checkout Session. + */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; }; /** PaymentPagesCheckoutSessionInvoiceCreation */ @@ -21486,21 +25292,42 @@ export interface components { }; /** PaymentPagesCheckoutSessionInvoiceSettings */ payment_pages_checkout_session_invoice_settings: { - /** @description The account tax IDs associated with the invoice. */ + /** + * @nullable + * @description The account tax IDs associated with the invoice. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; - /** @description Custom fields displayed on the invoice. */ + /** + * @nullable + * @description Custom fields displayed on the invoice. + */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Footer displayed on the invoice. */ + /** + * @nullable + * @description Footer displayed on the invoice. + */ footer?: string | null; - /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + /** + * @nullable + * @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. + */ issuer?: components["schemas"]["connect_account_reference"] | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description Options for invoice PDF rendering. */ + /** + * @nullable + * @description Options for invoice PDF rendering. + */ rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; }; /** PaymentPagesCheckoutSessionPaymentMethodReuseAgreement */ @@ -21520,14 +25347,19 @@ export interface components { }; /** PaymentPagesCheckoutSessionSavedPaymentMethodOptions */ payment_pages_checkout_session_saved_payment_method_options: { - /** @description Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. */ + /** + * @nullable + * @description Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. + */ allow_redisplay_filters?: ("always" | "limited" | "unspecified")[] | null; /** + * @nullable * @description Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. * @enum {string|null} */ payment_method_remove?: "disabled" | "enabled" | null; /** + * @nullable * @description Enable customers to choose if they wish to save their payment method for future use. Disabled by default. * @enum {string|null} */ @@ -21549,7 +25381,10 @@ export interface components { amount_tax: number; /** @description Total shipping cost after discounts and taxes are applied. */ amount_total: number; - /** @description The ID of the ShippingRate for this order. */ + /** + * @nullable + * @description The ID of the ShippingRate for this order. + */ shipping_rate?: (string | components["schemas"]["shipping_rate"]) | null; /** @description The taxes applied to the shipping rate. */ taxes?: components["schemas"]["line_items_tax_amount"][]; @@ -21568,7 +25403,10 @@ export interface components { * @enum {string} */ type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; - /** @description The value of the tax ID. */ + /** + * @nullable + * @description The value of the tax ID. + */ value?: string | null; }; /** PaymentPagesCheckoutSessionTaxIDCollection */ @@ -21585,7 +25423,10 @@ export interface components { payment_pages_checkout_session_total_details: { /** @description This is the sum of all the discounts. */ amount_discount: number; - /** @description This is the sum of all the shipping amounts. */ + /** + * @nullable + * @description This is the sum of all the shipping amounts. + */ amount_shipping?: number | null; /** @description This is the sum of all the tax amounts. */ amount_tax: number; @@ -21614,44 +25455,71 @@ export interface components { payout: { /** @description The amount (in cents (or local equivalent)) that transfers to your bank account or debit card. */ amount: number; - /** @description The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. */ + /** + * @nullable + * @description The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. + */ application_fee?: (string | components["schemas"]["application_fee"]) | null; - /** @description The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. */ + /** + * @nullable + * @description The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. + */ application_fee_amount?: number | null; /** - * Format: unix-time * @description Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. + * @format unix-time */ arrival_date: number; /** @description Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ automatic: boolean; - /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ + /** + * @nullable + * @description ID of the balance transaction that describes the impact of this payout on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description ID of the bank account or card the payout is sent to. */ + /** + * @nullable + * @description ID of the bank account or card the payout is sent to. + */ destination?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["deleted_bank_account"] | components["schemas"]["deleted_card"]) | null; - /** @description If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. */ + /** + * @nullable + * @description If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. + */ failure_balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; - /** @description Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). */ + /** + * @nullable + * @description Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). + */ failure_code?: string | null; - /** @description Message that provides the reason for a payout failure, if available. */ + /** + * @nullable + * @description Message that provides the reason for a payout failure, if available. + */ failure_message?: string | null; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -21662,22 +25530,34 @@ export interface components { * @enum {string} */ object: "payout"; - /** @description If the payout reverses another, this is the ID of the original payout. */ + /** + * @nullable + * @description If the payout reverses another, this is the ID of the original payout. + */ original_payout?: (string | components["schemas"]["payout"]) | null; /** * @description If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. * @enum {string} */ reconciliation_status: "completed" | "in_progress" | "not_applicable"; - /** @description If the payout reverses, this is the ID of the payout that reverses this payout. */ + /** + * @nullable + * @description If the payout reverses, this is the ID of the payout that reverses this payout. + */ reversed_by?: (string | components["schemas"]["payout"]) | null; /** @description The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`. */ source_type: string; - /** @description Extra information about a payout that displays on the user's bank statement. */ + /** + * @nullable + * @description Extra information about a payout that displays on the user's bank statement. + */ statement_descriptor?: string | null; /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. */ status: string; - /** @description A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar. */ + /** + * @nullable + * @description A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar. + */ trace_id?: components["schemas"]["payouts_trace_id"] | null; /** * @description Can be `bank_account` or `card`. @@ -21689,12 +25569,18 @@ export interface components { payouts_trace_id: { /** @description Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`. */ status: string; - /** @description The trace ID value if `trace_id.status` is `supported`, otherwise `nil`. */ + /** + * @nullable + * @description The trace ID value if `trace_id.status` is `supported`, otherwise `nil`. + */ value?: string | null; }; /** paypal_seller_protection */ paypal_seller_protection: { - /** @description An array of conditions that are covered for the transaction, if applicable. */ + /** + * @nullable + * @description An array of conditions that are covered for the transaction, if applicable. + */ dispute_categories?: ("fraudulent" | "product_not_received")[] | null; /** * @description Indicates whether the transaction is eligible for PayPal's seller protection. @@ -21705,13 +25591,15 @@ export interface components { /** Period */ period: { /** - * Format: unix-time + * @nullable * @description The end date of this usage period. All usage up to and including this point in time is included. + * @format unix-time */ end?: number | null; /** - * Format: unix-time + * @nullable * @description The start date of this usage period. All usage after this point in time is included. + * @format unix-time */ start?: number | null; }; @@ -21728,26 +25616,44 @@ export interface components { account: string; additional_tos_acceptances?: components["schemas"]["person_additional_tos_acceptances"]; address?: components["schemas"]["address"]; + /** @nullable */ address_kana?: components["schemas"]["legal_entity_japan_address"] | null; + /** @nullable */ address_kanji?: components["schemas"]["legal_entity_japan_address"] | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; dob?: components["schemas"]["legal_entity_dob"]; - /** @description The person's email address. */ + /** + * @nullable + * @description The person's email address. + */ email?: string | null; - /** @description The person's first name. */ + /** + * @nullable + * @description The person's first name. + */ first_name?: string | null; - /** @description The Kana variation of the person's first name (Japan only). */ + /** + * @nullable + * @description The Kana variation of the person's first name (Japan only). + */ first_name_kana?: string | null; - /** @description The Kanji variation of the person's first name (Japan only). */ + /** + * @nullable + * @description The Kanji variation of the person's first name (Japan only). + */ first_name_kanji?: string | null; /** @description A list of alternate names or aliases that the person is known by. */ full_name_aliases?: string[]; + /** @nullable */ future_requirements?: components["schemas"]["person_future_requirements"] | null; - /** @description The person's gender. */ + /** + * @nullable + * @description The person's gender. + */ gender?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -21755,26 +25661,44 @@ export interface components { id_number_provided?: boolean; /** @description Whether the person's `id_number_secondary` was provided. */ id_number_secondary_provided?: boolean; - /** @description The person's last name. */ + /** + * @nullable + * @description The person's last name. + */ last_name?: string | null; - /** @description The Kana variation of the person's last name (Japan only). */ + /** + * @nullable + * @description The Kana variation of the person's last name (Japan only). + */ last_name_kana?: string | null; - /** @description The Kanji variation of the person's last name (Japan only). */ + /** + * @nullable + * @description The Kanji variation of the person's last name (Japan only). + */ last_name_kanji?: string | null; - /** @description The person's maiden name. */ + /** + * @nullable + * @description The person's maiden name. + */ maiden_name?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { [key: string]: string; }; - /** @description The country where the person is a national. */ + /** + * @nullable + * @description The country where the person is a national. + */ nationality?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "person"; - /** @description The person's phone number. */ + /** + * @nullable + * @description The person's phone number. + */ phone?: string | null; /** * @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. @@ -21783,6 +25707,7 @@ export interface components { political_exposure?: "existing" | "none"; registered_address?: components["schemas"]["address"]; relationship?: components["schemas"]["person_relationship"]; + /** @nullable */ requirements?: components["schemas"]["person_requirements"] | null; /** @description Whether the last four digits of the person's Social Security number have been provided (U.S. only). */ ssn_last_4_provided?: boolean; @@ -21791,23 +25716,36 @@ export interface components { /** PersonAdditionalTOSAcceptance */ person_additional_tos_acceptance: { /** - * Format: unix-time + * @nullable * @description The Unix timestamp marking when the legal guardian accepted the service agreement. + * @format unix-time */ date?: number | null; - /** @description The IP address from which the legal guardian accepted the service agreement. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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: { - /** @description Details on the legal guardian's acceptance of the main Stripe service agreement. */ + /** + * @nullable + * @description Details on the legal guardian's acceptance of the main Stripe service agreement. + */ account?: components["schemas"]["person_additional_tos_acceptance"] | null; }; /** PersonFutureRequirements */ person_future_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** @description Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition. */ currently_due: string[]; @@ -21822,26 +25760,53 @@ export interface components { }; /** PersonRelationship */ person_relationship: { - /** @description Whether the person is the authorizer of the account's representative. */ + /** + * @nullable + * @description Whether the person is the authorizer of the account's representative. + */ authorizer?: boolean | null; - /** @description Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. */ + /** + * @nullable + * @description Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. + */ director?: boolean | null; - /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @description The percent owned by the person of the account's legal entity. + */ percent_ownership?: number | null; - /** @description Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. */ + /** + * @nullable + * @description Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. + */ representative?: boolean | null; - /** @description The person's title (e.g., CEO, Support Engineer). */ + /** + * @nullable + * @description The person's title (e.g., CEO, Support Engineer). + */ title?: string | null; }; /** PersonRequirements */ person_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** + * @nullable + * @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. + */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** @description Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ currently_due: string[]; @@ -21869,15 +25834,20 @@ export interface components { /** @description Whether the plan can be used for new purchases. */ active: boolean; /** + * @nullable * @description Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. * @enum {string|null} */ aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum" | null; - /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /** + * @nullable + * @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + */ amount?: number | null; /** - * Format: decimal + * @nullable * @description The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * @format decimal */ amount_decimal?: string | null; /** @@ -21886,13 +25856,13 @@ export interface components { */ billing_scheme: "per_unit" | "tiered"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Unique identifier for the object. */ @@ -21906,31 +25876,50 @@ export interface components { interval_count: number; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description The meter tracking the usage of a metered price */ + /** + * @nullable + * @description The meter tracking the usage of a metered price + */ meter?: string | null; - /** @description A brief description of the plan, hidden from customers. */ + /** + * @nullable + * @description A brief description of the plan, hidden from customers. + */ nickname?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "plan"; - /** @description The product whose pricing this plan determines. */ + /** + * @nullable + * @description The product whose pricing this plan determines. + */ product?: (string | components["schemas"]["product"] | components["schemas"]["deleted_product"]) | null; /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: components["schemas"]["plan_tier"][]; /** + * @nullable * @description Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. * @enum {string|null} */ tiers_mode?: "graduated" | "volume" | null; - /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ + /** + * @nullable + * @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. + */ transform_usage?: components["schemas"]["transform_usage"] | null; - /** @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). */ + /** + * @nullable + * @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + */ trial_period_days?: number | null; /** * @description Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. @@ -21940,21 +25929,32 @@ export interface components { }; /** PlanTier */ plan_tier: { - /** @description Price for the entire tier. */ + /** + * @nullable + * @description Price for the entire tier. + */ flat_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ flat_amount_decimal?: string | null; - /** @description Per unit price for units relevant to the tier. */ + /** + * @nullable + * @description Per unit price for units relevant to the tier. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ unit_amount_decimal?: string | null; - /** @description Up to and including to this quantity will be contained in the tier. */ + /** + * @nullable + * @description Up to and including to this quantity will be contained in the tier. + */ up_to?: number | null; }; /** PlatformEarningFeeSource */ @@ -21971,11 +25971,20 @@ export interface components { }; /** PortalBusinessProfile */ portal_business_profile: { - /** @description The messaging shown to customers in the portal. */ + /** + * @nullable + * @description The messaging shown to customers in the portal. + */ headline?: string | null; - /** @description A link to the business’s publicly available privacy policy. */ + /** + * @nullable + * @description A link to the business’s publicly available privacy policy. + */ privacy_policy_url?: string | null; - /** @description A link to the business’s publicly available terms of service. */ + /** + * @nullable + * @description A link to the business’s publicly available terms of service. + */ terms_of_service_url?: string | null; }; /** PortalCustomerUpdate */ @@ -21995,7 +26004,10 @@ export interface components { }; /** PortalFlowsAfterCompletionHostedConfirmation */ portal_flows_after_completion_hosted_confirmation: { - /** @description A custom message to display to the customer after the flow is completed. */ + /** + * @nullable + * @description A custom message to display to the customer after the flow is completed. + */ custom_message?: string | null; }; /** PortalFlowsAfterCompletionRedirect */ @@ -22011,11 +26023,20 @@ export interface components { /** PortalFlowsFlow */ portal_flows_flow: { after_completion: components["schemas"]["portal_flows_flow_after_completion"]; - /** @description Configuration when `flow.type=subscription_cancel`. */ + /** + * @nullable + * @description Configuration when `flow.type=subscription_cancel`. + */ subscription_cancel?: components["schemas"]["portal_flows_flow_subscription_cancel"] | null; - /** @description Configuration when `flow.type=subscription_update`. */ + /** + * @nullable + * @description Configuration when `flow.type=subscription_update`. + */ subscription_update?: components["schemas"]["portal_flows_flow_subscription_update"] | null; - /** @description Configuration when `flow.type=subscription_update_confirm`. */ + /** + * @nullable + * @description Configuration when `flow.type=subscription_update_confirm`. + */ subscription_update_confirm?: components["schemas"]["portal_flows_flow_subscription_update_confirm"] | null; /** * @description Type of flow that the customer will go through. @@ -22025,9 +26046,15 @@ export interface components { }; /** PortalFlowsFlowAfterCompletion */ portal_flows_flow_after_completion: { - /** @description Configuration when `after_completion.type=hosted_confirmation`. */ + /** + * @nullable + * @description Configuration when `after_completion.type=hosted_confirmation`. + */ hosted_confirmation?: components["schemas"]["portal_flows_after_completion_hosted_confirmation"] | null; - /** @description Configuration when `after_completion.type=redirect`. */ + /** + * @nullable + * @description Configuration when `after_completion.type=redirect`. + */ redirect?: components["schemas"]["portal_flows_after_completion_redirect"] | null; /** * @description The specified type of behavior after the flow is completed. @@ -22037,7 +26064,10 @@ export interface components { }; /** PortalFlowsFlowSubscriptionCancel */ portal_flows_flow_subscription_cancel: { - /** @description Specify a retention strategy to be used in the cancellation flow. */ + /** + * @nullable + * @description Specify a retention strategy to be used in the cancellation flow. + */ retention?: components["schemas"]["portal_flows_retention"] | null; /** @description The ID of the subscription to be canceled. */ subscription: string; @@ -22049,7 +26079,10 @@ export interface components { }; /** PortalFlowsFlowSubscriptionUpdateConfirm */ portal_flows_flow_subscription_update_confirm: { - /** @description The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified. */ + /** + * @nullable + * @description The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified. + */ discounts?: components["schemas"]["portal_flows_subscription_update_confirm_discount"][] | null; /** @description The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. */ items: components["schemas"]["portal_flows_subscription_update_confirm_item"][]; @@ -22058,7 +26091,10 @@ export interface components { }; /** PortalFlowsRetention */ portal_flows_retention: { - /** @description Configuration when `retention.type=coupon_offer`. */ + /** + * @nullable + * @description Configuration when `retention.type=coupon_offer`. + */ coupon_offer?: components["schemas"]["portal_flows_coupon_offer"] | null; /** * @description Type of retention strategy that will be used. @@ -22068,16 +26104,28 @@ export interface components { }; /** PortalFlowsSubscriptionUpdateConfirmDiscount */ portal_flows_subscription_update_confirm_discount: { - /** @description The ID of the coupon to apply to this subscription update. */ + /** + * @nullable + * @description The ID of the coupon to apply to this subscription update. + */ coupon?: string | null; - /** @description The ID of a promotion code to apply to this subscription update. */ + /** + * @nullable + * @description The ID of a promotion code to apply to this subscription update. + */ promotion_code?: string | null; }; /** PortalFlowsSubscriptionUpdateConfirmItem */ portal_flows_subscription_update_confirm_item: { - /** @description The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. */ + /** + * @nullable + * @description The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. + */ id?: string | null; - /** @description The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). */ + /** + * @nullable + * @description The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). + */ price?: string | null; /** @description [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow. */ quantity?: number; @@ -22095,7 +26143,10 @@ export interface components { * If `false`, the previously generated `url`, if any, will be deactivated. */ enabled: boolean; - /** @description A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal. */ + /** + * @nullable + * @description A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal. + */ url?: string | null; }; /** PortalPaymentMethodUpdate */ @@ -22145,7 +26196,10 @@ export interface components { default_allowed_updates: ("price" | "promotion_code" | "quantity")[]; /** @description Whether the feature is enabled. */ enabled: boolean; - /** @description The list of up to 10 products that support subscription updates. */ + /** + * @nullable + * @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`. Defaults to a value of `none` if you don't set it during creation. @@ -22179,32 +26233,41 @@ export interface components { */ billing_scheme: "per_unit" | "tiered"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { [key: string]: components["schemas"]["currency_option"]; }; - /** @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. */ + /** + * @nullable + * @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. + */ custom_unit_amount?: components["schemas"]["custom_unit_amount"] | null; /** @description 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 A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ + /** + * @nullable + * @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. + */ lookup_key?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { [key: string]: string; }; - /** @description A brief description of the price, hidden from customers. */ + /** + * @nullable + * @description A brief description of the price, hidden from customers. + */ nickname?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -22213,9 +26276,13 @@ export interface components { object: "price"; /** @description The ID of the product this price is associated with. */ product: string | components["schemas"]["product"] | components["schemas"]["deleted_product"]; - /** @description The recurring components of a price such as `interval` and `usage_type`. */ + /** + * @nullable + * @description The recurring components of a price such as `interval` and `usage_type`. + */ recurring?: components["schemas"]["recurring"] | null; /** + * @nullable * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string|null} */ @@ -22223,42 +26290,61 @@ export interface components { /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: components["schemas"]["price_tier"][]; /** + * @nullable * @description Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. * @enum {string|null} */ tiers_mode?: "graduated" | "volume" | null; - /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ + /** + * @nullable + * @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. + */ transform_quantity?: components["schemas"]["transform_quantity"] | null; /** * @description One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. * @enum {string} */ type: "one_time" | "recurring"; - /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /** + * @nullable + * @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * @format decimal */ unit_amount_decimal?: string | null; }; /** PriceTier */ price_tier: { - /** @description Price for the entire tier. */ + /** + * @nullable + * @description Price for the entire tier. + */ flat_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ flat_amount_decimal?: string | null; - /** @description Per unit price for units relevant to the tier. */ + /** + * @nullable + * @description Per unit price for units relevant to the tier. + */ unit_amount?: number | null; /** - * Format: decimal + * @nullable * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + * @format decimal */ unit_amount_decimal?: string | null; - /** @description Up to and including to this quantity will be contained in the tier. */ + /** + * @nullable + * @description Up to and including to this quantity will be contained in the tier. + */ up_to?: number | null; }; /** @@ -22276,13 +26362,19 @@ export interface components { /** @description Whether the product is currently available for purchase. */ active: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. */ + /** + * @nullable + * @description The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. + */ default_price?: (string | components["schemas"]["price"]) | null; - /** @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ + /** + * @nullable + * @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. + */ description?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -22303,22 +26395,40 @@ export interface components { * @enum {string} */ object: "product"; - /** @description The dimensions of this product for shipping purposes. */ + /** + * @nullable + * @description The dimensions of this product for shipping purposes. + */ package_dimensions?: components["schemas"]["package_dimensions"] | null; - /** @description Whether this product is shipped (i.e., physical goods). */ + /** + * @nullable + * @description Whether this product is shipped (i.e., physical goods). + */ shippable?: boolean | null; - /** @description Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments. */ + /** + * @nullable + * @description Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments. + */ statement_descriptor?: string | null; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. */ + /** + * @nullable + * @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + */ tax_code?: (string | components["schemas"]["tax_code"]) | null; - /** @description A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. */ + /** + * @nullable + * @description A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. + */ unit_label?: string | null; /** - * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; - /** @description A URL of a publicly-accessible webpage for this product. */ + /** + * @nullable + * @description A URL of a publicly-accessible webpage for this product. + */ url?: string | null; }; /** @@ -22355,24 +26465,34 @@ export interface components { code: string; coupon: components["schemas"]["coupon"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The customer that this promotion code can be used by. */ + /** + * @nullable + * @description The customer that this promotion code can be used by. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** - * Format: unix-time + * @nullable * @description Date at which the promotion code can no longer be redeemed. + * @format unix-time */ 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 Maximum number of times this promotion code can be redeemed. */ + /** + * @nullable + * @description Maximum number of times this promotion code can be redeemed. + */ max_redemptions?: number | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -22398,9 +26518,15 @@ export interface components { }; /** @description A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices */ first_time_transaction: boolean; - /** @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ + /** + * @nullable + * @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). + */ minimum_amount?: number | null; - /** @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount */ + /** + * @nullable + * @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount + */ minimum_amount_currency?: string | null; }; /** @@ -22413,11 +26539,20 @@ export interface components { amount_subtotal: number; /** @description Total after discounts and taxes are applied. */ amount_total: number; - /** @description ID of the Connect Application that created the quote. */ + /** + * @nullable + * @description ID of the Connect Application that created the quote. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. */ + /** + * @nullable + * @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. + */ application_fee_amount?: number | null; - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. + */ application_fee_percent?: number | null; automatic_tax: components["schemas"]["quotes_resource_automatic_tax"]; /** @@ -22427,34 +26562,55 @@ export interface components { collection_method: "charge_automatically" | "send_invoice"; computed: components["schemas"]["quotes_resource_computed"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ 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). */ + /** + * @nullable + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string | null; - /** @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ + /** + * @nullable + * @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** @description The tax rates applied to this quote. */ default_tax_rates?: (string | components["schemas"]["tax_rate"])[]; - /** @description A description that will be displayed on the quote PDF. */ + /** + * @nullable + * @description A description that will be displayed on the quote PDF. + */ description?: string | null; /** @description The discounts applied to this quote. */ discounts: (string | components["schemas"]["discount"])[]; /** - * Format: unix-time * @description The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. + * @format unix-time */ expires_at: number; - /** @description A footer that will be displayed on the quote PDF. */ + /** + * @nullable + * @description A footer that will be displayed on the quote PDF. + */ footer?: string | null; - /** @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. */ + /** + * @nullable + * @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. + */ from_quote?: components["schemas"]["quotes_resource_from_quote"] | null; - /** @description A header that will be displayed on the quote PDF. */ + /** + * @nullable + * @description A header that will be displayed on the quote PDF. + */ header?: string | null; /** @description Unique identifier for the object. */ id: string; - /** @description The invoice that was created from this quote. */ + /** + * @nullable + * @description The invoice that was created from this quote. + */ invoice?: (string | components["schemas"]["invoice"] | components["schemas"]["deleted_invoice"]) | null; invoice_settings: components["schemas"]["invoice_setting_quote_setting"]; /** @@ -22480,14 +26636,20 @@ export interface components { metadata: { [key: string]: string; }; - /** @description A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). */ + /** + * @nullable + * @description A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). + */ number?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "quote"; - /** @description The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. */ + /** + * @nullable + * @description The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** * @description The status of the quote. @@ -22495,24 +26657,40 @@ export interface components { */ status: "accepted" | "canceled" | "draft" | "open"; status_transitions: components["schemas"]["quotes_resource_status_transitions"]; - /** @description The subscription that was created or updated from this quote. */ + /** + * @nullable + * @description The subscription that was created or updated from this quote. + */ subscription?: (string | components["schemas"]["subscription"]) | null; subscription_data: components["schemas"]["quotes_resource_subscription_data_subscription_data"]; - /** @description The subscription schedule that was created or updated from this quote. */ + /** + * @nullable + * @description The subscription schedule that was created or updated from this quote. + */ subscription_schedule?: (string | components["schemas"]["subscription_schedule"]) | null; - /** @description ID of the test clock this quote belongs to. */ + /** + * @nullable + * @description ID of the test clock this quote belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; total_details: components["schemas"]["quotes_resource_total_details"]; - /** @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. */ + /** + * @nullable + * @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. + */ transfer_data?: components["schemas"]["quotes_resource_transfer_data"] | null; }; /** QuotesResourceAutomaticTax */ quotes_resource_automatic_tax: { /** @description Automatically calculate taxes */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; /** + * @nullable * @description The status of the most recent automated tax calculation for this quote. * @enum {string|null} */ @@ -22520,7 +26698,10 @@ export interface components { }; /** QuotesResourceComputed */ quotes_resource_computed: { - /** @description The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices. */ + /** + * @nullable + * @description The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices. + */ recurring?: components["schemas"]["quotes_resource_recurring"] | null; upfront: components["schemas"]["quotes_resource_upfront"]; }; @@ -22549,42 +26730,58 @@ export interface components { /** QuotesResourceStatusTransitions */ quotes_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description The time that the quote was accepted. Measured in seconds since Unix epoch. + * @format unix-time */ accepted_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the quote was canceled. Measured in seconds since Unix epoch. + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description The time that the quote was finalized. Measured in seconds since Unix epoch. + * @format unix-time */ finalized_at?: number | null; }; /** 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 for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @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 + * @nullable * @description When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch. + * @format unix-time */ 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. */ + /** + * @nullable + * @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; } | null; - /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ + /** + * @nullable + * @description Integer representing the number of trial period days before the customer is charged for the first time. + */ trial_period_days?: number | null; }; /** QuotesResourceTotalDetails */ quotes_resource_total_details: { /** @description This is the sum of all the discounts. */ amount_discount: number; - /** @description This is the sum of all the shipping amounts. */ + /** + * @nullable + * @description This is the sum of all the shipping amounts. + */ amount_shipping?: number | null; /** @description This is the sum of all the tax amounts. */ amount_tax: number; @@ -22599,9 +26796,15 @@ export interface components { }; /** QuotesResourceTransferData */ quotes_resource_transfer_data: { - /** @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ + /** + * @nullable + * @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. + */ amount?: number | null; - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. + */ amount_percent?: number | null; /** @description The account where funds from the payment will be transferred to upon payment success. */ destination: string | components["schemas"]["account"]; @@ -22644,8 +26847,8 @@ export interface components { /** @description ID of the charge this early fraud warning is for, optionally expanded. */ charge: string | components["schemas"]["charge"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. */ @@ -22672,8 +26875,8 @@ export interface components { /** @description The name of the value list for use in rules. */ alias: string; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The name or email address of the user who created this value list. */ @@ -22724,8 +26927,8 @@ export interface components { */ "radar.value_list_item": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description The name or email address of the user who added this item to the value list. */ @@ -22754,26 +26957,53 @@ export interface components { }; /** RadarReviewResourceLocation */ radar_review_resource_location: { - /** @description The city where the payment originated. */ + /** + * @nullable + * @description The city where the payment originated. + */ city?: string | null; - /** @description Two-letter ISO code representing the country where the payment originated. */ + /** + * @nullable + * @description Two-letter ISO code representing the country where the payment originated. + */ country?: string | null; - /** @description The geographic latitude where the payment originated. */ + /** + * @nullable + * @description The geographic latitude where the payment originated. + */ latitude?: number | null; - /** @description The geographic longitude where the payment originated. */ + /** + * @nullable + * @description The geographic longitude where the payment originated. + */ longitude?: number | null; - /** @description The state/county/province/region where the payment originated. */ + /** + * @nullable + * @description The state/county/province/region where the payment originated. + */ region?: string | null; }; /** RadarReviewResourceSession */ radar_review_resource_session: { - /** @description The browser used in this browser session (e.g., `Chrome`). */ + /** + * @nullable + * @description The browser used in this browser session (e.g., `Chrome`). + */ browser?: string | null; - /** @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ + /** + * @nullable + * @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). + */ device?: string | null; - /** @description The platform for the browser session (e.g., `Macintosh`). */ + /** + * @nullable + * @description The platform for the browser session (e.g., `Macintosh`). + */ platform?: string | null; - /** @description The version for the browser session (e.g., `61.0.3163.100`). */ + /** + * @nullable + * @description The version for the browser session (e.g., `61.0.3163.100`). + */ version?: string | null; }; /** received_payment_method_details_financial_account */ @@ -22789,6 +27019,7 @@ export interface components { /** Recurring */ recurring: { /** + * @nullable * @description Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`. * @enum {string|null} */ @@ -22800,7 +27031,10 @@ export interface components { interval: "day" | "month" | "week" | "year"; /** @description The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ interval_count: number; - /** @description The meter tracking the usage of a metered price */ + /** + * @nullable + * @description The meter tracking the usage of a metered price + */ meter?: string | null; /** * @description Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. @@ -22819,18 +27053,24 @@ export interface components { refund: { /** @description Amount, in cents (or local equivalent). */ amount: number; - /** @description Balance transaction that describes the impact on your account balance. */ + /** + * @nullable + * @description Balance transaction that describes the impact on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; - /** @description ID of the charge that's refunded. */ + /** + * @nullable + * @description ID of the charge that's refunded. + */ charge?: (string | components["schemas"]["charge"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). */ @@ -22844,7 +27084,10 @@ export interface components { id: string; /** @description For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. */ instructions_email?: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -22854,20 +27097,36 @@ export interface components { * @enum {string} */ object: "refund"; - /** @description ID of the PaymentIntent that's refunded. */ + /** + * @nullable + * @description ID of the PaymentIntent that's refunded. + */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; /** + * @nullable * @description Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). * @enum {string|null} */ reason?: "duplicate" | "expired_uncaptured_charge" | "fraudulent" | "requested_by_customer" | null; - /** @description This is the transaction number that appears on email receipts sent for this refund. */ + /** + * @nullable + * @description This is the transaction number that appears on email receipts sent for this refund. + */ receipt_number?: string | null; - /** @description The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. */ + /** + * @nullable + * @description The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. + */ source_transfer_reversal?: (string | components["schemas"]["transfer_reversal"]) | null; - /** @description Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). */ + /** + * @nullable + * @description Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). + */ status?: string | null; - /** @description This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. */ + /** + * @nullable + * @description This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. + */ transfer_reversal?: (string | components["schemas"]["transfer_reversal"]) | null; }; /** refund_destination_details */ @@ -22908,18 +27167,33 @@ export interface components { }; /** refund_destination_details_blik */ refund_destination_details_blik: { - /** @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. */ + /** + * @nullable + * @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. + */ network_decline_code?: string | null; - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_br_bank_transfer */ refund_destination_details_br_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_card */ @@ -22938,67 +27212,124 @@ export interface components { }; /** refund_destination_details_eu_bank_transfer */ refund_destination_details_eu_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_gb_bank_transfer */ refund_destination_details_gb_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_jp_bank_transfer */ refund_destination_details_jp_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_multibanco */ refund_destination_details_multibanco: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_mx_bank_transfer */ refund_destination_details_mx_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_p24 */ refund_destination_details_p24: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_swish */ refund_destination_details_swish: { - /** @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. */ + /** + * @nullable + * @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. + */ network_decline_code?: string | null; - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_th_bank_transfer */ refund_destination_details_th_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** refund_destination_details_us_bank_transfer */ refund_destination_details_us_bank_transfer: { - /** @description The reference assigned to the refund. */ + /** + * @nullable + * @description The reference assigned to the refund. + */ reference?: string | null; - /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /** + * @nullable + * @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. + */ reference_status?: string | null; }; /** RefundNextAction */ @@ -23011,8 +27342,8 @@ export interface components { refund_next_action_display_details: { email_sent: components["schemas"]["email_sent"]; /** - * Format: unix-time * @description The expiry timestamp. + * @format unix-time */ expires_at: number; }; @@ -23029,11 +27360,12 @@ export interface components { */ "reporting.report_run": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** + * @nullable * @description If something should go wrong during the run, a message about the failure (populated when * `status=failed`). */ @@ -23051,6 +27383,7 @@ export interface components { /** @description The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. */ report_type: string; /** + * @nullable * @description The file object representing the result of the report run (populated when * `status=succeeded`). */ @@ -23062,9 +27395,10 @@ export interface components { */ status: string; /** - * Format: unix-time + * @nullable * @description Timestamp at which this run successfully finished (populated when * `status=succeeded`). Measured in seconds since the Unix epoch. + * @format unix-time */ succeeded_at?: number | null; }; @@ -23081,16 +27415,19 @@ export interface components { */ "reporting.report_type": { /** - * Format: unix-time * @description Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. + * @format unix-time */ data_available_end: number; /** - * Format: unix-time * @description Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. + * @format unix-time */ data_available_start: number; - /** @description List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.) */ + /** + * @nullable + * @description List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.) + */ default_columns?: string[] | null; /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ id: string; @@ -23104,8 +27441,8 @@ export interface components { */ object: "reporting.report_type"; /** - * Format: unix-time * @description When this Report Type was latest updated. Measured in seconds since the Unix epoch. + * @format unix-time */ updated: number; /** @description Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas. */ @@ -23115,11 +27452,14 @@ export interface components { reserve_transaction: { amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -23137,25 +27477,38 @@ export interface components { * [here](https://stripe.com/docs/radar/reviews). */ review: { - /** @description The ZIP or postal code of the card used, if applicable. */ + /** + * @nullable + * @description The ZIP or postal code of the card used, if applicable. + */ billing_zip?: string | null; - /** @description The charge associated with this review. */ + /** + * @nullable + * @description The charge associated with this review. + */ charge?: (string | components["schemas"]["charge"]) | null; /** + * @nullable * @description The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. * @enum {string|null} */ closed_reason?: "approved" | "disputed" | "redacted" | "refunded" | "refunded_as_fraud" | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ id: string; - /** @description The IP address where the payment originated. */ + /** + * @nullable + * @description The IP address where the payment originated. + */ ip_address?: string | null; - /** @description Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. */ + /** + * @nullable + * @description Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. + */ ip_address_location?: components["schemas"]["radar_review_resource_location"] | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -23175,13 +27528,17 @@ export interface components { payment_intent?: string | components["schemas"]["payment_intent"]; /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ reason: string; - /** @description Information related to the browsing session of the user who initiated the payment. */ + /** + * @nullable + * @description Information related to the browsing session of the user who initiated the payment. + */ session?: components["schemas"]["radar_review_resource_session"] | null; }; /** revolut_pay_underlying_payment_method_funding_details */ revolut_pay_underlying_payment_method_funding_details: { card?: components["schemas"]["payment_method_details_passthrough_card"]; /** + * @nullable * @description funding type of the underlying payment method. * @enum {string|null} */ @@ -23205,17 +27562,20 @@ export interface components { */ scheduled_query_run: { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time * @description When the query was run, Sigma contained a snapshot of your Stripe data at this time. + * @format unix-time */ data_load_time: number; error?: components["schemas"]["sigma_scheduled_query_run_error"]; - /** @description The file object representing the results of the query. */ + /** + * @nullable + * @description The file object representing the results of the query. + */ file?: components["schemas"]["file"] | null; /** @description Unique identifier for the object. */ id: string; @@ -23227,8 +27587,8 @@ export interface components { */ object: "scheduled_query_run"; /** - * Format: unix-time * @description Time at which the result expires and is no longer available for download. + * @format unix-time */ result_available_until: number; /** @description SQL for the query. */ @@ -23241,13 +27601,17 @@ export interface components { /** SchedulesPhaseAutomaticTax */ schedules_phase_automatic_tax: { /** + * @nullable * @description If Stripe disabled automatic tax, this enum describes why. * @enum {string|null} */ disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; }; /** SecretServiceResourceScope */ @@ -23262,9 +27626,15 @@ export interface components { }; /** sepa_debit_generated_from */ sepa_debit_generated_from: { - /** @description The ID of the Charge that generated this PaymentMethod, if any. */ + /** + * @nullable + * @description The ID of the Charge that generated this PaymentMethod, if any. + */ charge?: (string | components["schemas"]["charge"]) | null; - /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ + /** + * @nullable + * @description The ID of the SetupAttempt that generated this PaymentMethod, if any. + */ setup_attempt?: (string | components["schemas"]["setup_attempt"]) | null; }; /** @@ -23275,7 +27645,10 @@ export interface components { * payment method using a SetupIntent. */ setup_attempt: { - /** @description The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. */ + /** + * @nullable + * @description The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. + */ application?: (string | components["schemas"]["application"]) | null; /** * @description If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -23284,13 +27657,17 @@ export interface components { */ attach_to_self?: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. */ + /** + * @nullable + * @description The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. + */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** + * @nullable * @description Indicates the directions of money movement for which this payment method is intended to be used. * * Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. @@ -23305,12 +27682,18 @@ export interface components { * @enum {string} */ object: "setup_attempt"; - /** @description The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. */ + /** + * @nullable + * @description The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** @description ID of the payment method used with this SetupAttempt. */ payment_method: string | components["schemas"]["payment_method"]; payment_method_details: components["schemas"]["setup_attempt_payment_method_details"]; - /** @description The error encountered during this attempt to confirm the SetupIntent, if any. */ + /** + * @nullable + * @description The error encountered during this attempt to confirm the SetupIntent, if any. + */ setup_error?: components["schemas"]["api_errors"] | null; /** @description ID of the SetupIntent that this attempt belongs to. */ setup_intent: string | components["schemas"]["setup_intent"]; @@ -23353,25 +27736,45 @@ export interface components { setup_attempt_payment_method_details_bacs_debit: Record; /** setup_attempt_payment_method_details_bancontact */ setup_attempt_payment_method_details_bancontact: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ preferred_language?: "de" | "en" | "fr" | "nl" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -23381,47 +27784,93 @@ export interface components { setup_attempt_payment_method_details_boleto: Record; /** setup_attempt_payment_method_details_card */ setup_attempt_payment_method_details_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ brand?: string | null; - /** @description Check results by Card networks on Card address and CVC at the time of authorization */ + /** + * @nullable + * @description Check results by Card networks on Card address and CVC at the time of authorization + */ checks?: components["schemas"]["setup_attempt_payment_method_details_card_checks"] | null; - /** @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. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @description Two-digit number representing the card's expiration month. + */ exp_month?: number | null; - /** @description Four-digit number representing the card's expiration year. */ + /** + * @nullable + * @description Four-digit number representing the card's expiration year. + */ exp_year?: number | null; /** + * @nullable * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. * * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* */ fingerprint?: string | null; - /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /** + * @nullable + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + */ funding?: string | null; - /** @description The last four digits of the card. */ + /** + * @nullable + * @description The last four digits of the card. + */ last4?: string | null; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** + * @nullable + * @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + */ network?: string | null; - /** @description Populated if this authorization used 3D Secure authentication. */ + /** + * @nullable + * @description Populated if this authorization used 3D Secure authentication. + */ three_d_secure?: components["schemas"]["three_d_secure_details"] | null; - /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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`. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @description The ID of the Card PaymentMethod which was generated by this SetupAttempt. + */ generated_card?: (string | components["schemas"]["payment_method"]) | null; - /** @description Details about payments collected offline. */ + /** + * @nullable + * @description Details about payments collected offline. + */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; }; /** setup_attempt_payment_method_details_card_wallet */ @@ -23439,22 +27888,34 @@ export interface components { /** setup_attempt_payment_method_details_ideal */ setup_attempt_payment_method_details_ideal: { /** + * @nullable * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; /** + * @nullable * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -23476,25 +27937,45 @@ export interface components { setup_attempt_payment_method_details_sepa_debit: Record; /** setup_attempt_payment_method_details_sofort */ setup_attempt_payment_method_details_sofort: { - /** @description Bank code of bank associated with the bank account. */ + /** + * @nullable + * @description Bank code of bank associated with the bank account. + */ bank_code?: string | null; - /** @description Name of the bank associated with the bank account. */ + /** + * @nullable + * @description Name of the bank associated with the bank account. + */ bank_name?: string | null; - /** @description Bank Identifier Code of the bank associated with the bank account. */ + /** + * @nullable + * @description Bank Identifier Code of the bank associated with the bank account. + */ bic?: string | null; - /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; - /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /** + * @nullable + * @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. + */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Last four characters of the IBAN. */ + /** + * @nullable + * @description Last four characters of the IBAN. + */ iban_last4?: string | null; /** + * @nullable * @description Preferred language of the Sofort authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ preferred_language?: "de" | "en" | "fr" | "nl" | null; /** + * @nullable * @description Owner's verified full name. Values are verified or provided by Sofort directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ @@ -23527,7 +28008,10 @@ export interface components { * Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) */ setup_intent: { - /** @description ID of the Connect application that created the SetupIntent. */ + /** + * @nullable + * @description ID of the Connect application that created the SetupIntent. + */ application?: (string | components["schemas"]["application"]) | null; /** * @description If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -23535,33 +28019,43 @@ export interface components { * It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. */ attach_to_self?: boolean; - /** @description Settings for dynamic payment methods compatible with this Setup Intent */ + /** + * @nullable + * @description Settings for dynamic payment methods compatible with this Setup Intent + */ automatic_payment_methods?: components["schemas"]["payment_flows_automatic_payment_methods_setup_intent"] | null; /** + * @nullable * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. * @enum {string|null} */ cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer" | null; /** + * @nullable * @description The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. */ client_secret?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** + * @nullable * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; /** + * @nullable * @description Indicates the directions of money movement for which this payment method is intended to be used. * * Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. @@ -23569,36 +28063,66 @@ export interface components { flow_directions?: ("inbound" | "outbound")[] | null; /** @description Unique identifier for the object. */ id: string; - /** @description The error encountered in the previous SetupIntent confirmation. */ + /** + * @nullable + * @description The error encountered in the previous SetupIntent confirmation. + */ last_setup_error?: components["schemas"]["api_errors"] | null; - /** @description The most recent SetupAttempt for this SetupIntent. */ + /** + * @nullable + * @description The most recent SetupAttempt for this SetupIntent. + */ latest_attempt?: (string | components["schemas"]["setup_attempt"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description ID of the multi use Mandate generated by the SetupIntent. */ + /** + * @nullable + * @description ID of the multi use Mandate generated by the SetupIntent. + */ mandate?: (string | components["schemas"]["mandate"]) | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */ + /** + * @nullable + * @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. + */ next_action?: components["schemas"]["setup_intent_next_action"] | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "setup_intent"; - /** @description The account (if any) for which the setup is intended. */ + /** + * @nullable + * @description The account (if any) for which the setup is intended. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. */ + /** + * @nullable + * @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. + */ payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent. */ + /** + * @nullable + * @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent. + */ payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; - /** @description Payment method-specific configuration for this SetupIntent. */ + /** + * @nullable + * @description Payment method-specific configuration for this SetupIntent. + */ payment_method_options?: components["schemas"]["setup_intent_payment_method_options"] | null; /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ payment_method_types: string[]; - /** @description ID of the single_use Mandate generated by the SetupIntent. */ + /** + * @nullable + * @description ID of the single_use Mandate generated by the SetupIntent. + */ single_use_mandate?: (string | components["schemas"]["mandate"]) | null; /** * @description [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. @@ -23624,21 +28148,28 @@ export interface components { }; /** SetupIntentNextActionRedirectToUrl */ setup_intent_next_action_redirect_to_url: { - /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ + /** + * @nullable + * @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. + */ return_url?: string | null; - /** @description The URL you must redirect your customer to in order to authenticate. */ + /** + * @nullable + * @description The URL you must redirect your customer to in order to authenticate. + */ url?: string | null; }; /** SetupIntentNextActionVerifyWithMicrodeposits */ setup_intent_next_action_verify_with_microdeposits: { /** - * Format: unix-time * @description The timestamp when the microdeposits are expected to land. + * @format unix-time */ arrival_date: number; /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ hosted_verification_url: string; /** + * @nullable * @description The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. * @enum {string|null} */ @@ -23659,6 +28190,7 @@ export interface components { /** setup_intent_payment_method_options_acss_debit */ setup_intent_payment_method_options_acss_debit: { /** + * @nullable * @description Currency supported by the bank account * @enum {string|null} */ @@ -23678,14 +28210,19 @@ export interface components { }; /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { - /** @description Configuration options for setting up an eMandate for cards issued in India. */ + /** + * @nullable + * @description Configuration options for setting up an eMandate for cards issued in India. + */ mandate_options?: components["schemas"]["setup_intent_payment_method_options_card_mandate_options"] | null; /** + * @nullable * @description Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. * @enum {string|null} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** + * @nullable * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ @@ -23701,15 +28238,19 @@ export interface components { */ amount_type: "fixed" | "maximum"; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ + /** + * @nullable + * @description A description of the mandate or subscription that is meant to be displayed to the customer. + */ description?: string | null; /** - * Format: unix-time + * @nullable * @description End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. + * @format unix-time */ end_date?: number | null; /** @@ -23717,16 +28258,22 @@ export interface components { * @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; - /** @description The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. */ + /** + * @nullable + * @description The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. + */ interval_count?: number | null; /** @description Unique identifier for the mandate or subscription. */ reference: string; /** - * Format: unix-time * @description Start date of the mandate or subscription. Start date should not be lesser than yesterday. + * @format unix-time */ start_date: number; - /** @description Specifies the type of mandates supported. Possible values are `india`. */ + /** + * @nullable + * @description Specifies the type of mandates supported. Possible values are `india`. + */ supported_types?: "india"[] | null; }; /** setup_intent_payment_method_options_card_present */ @@ -23739,14 +28286,19 @@ export interface components { custom_mandate_url?: string; /** @description List of Stripe products where this mandate can be selected automatically. */ default_for?: ("invoice" | "subscription")[]; - /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /** + * @nullable + * @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. + */ interval_description?: string | null; /** + * @nullable * @description Payment schedule for the mandate. * @enum {string|null} */ payment_schedule?: "combined" | "interval" | "sporadic" | null; /** + * @nullable * @description Transaction type of the mandate. * @enum {string|null} */ @@ -23764,7 +28316,10 @@ export interface components { }; /** setup_intent_payment_method_options_paypal */ setup_intent_payment_method_options_paypal: { - /** @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. */ + /** + * @nullable + * @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. + */ billing_agreement_id?: string | null; }; /** setup_intent_payment_method_options_sepa_debit */ @@ -23792,13 +28347,22 @@ export interface components { /** Shipping */ shipping: { address?: components["schemas"]["address"]; - /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ + /** + * @nullable + * @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. + */ carrier?: string | null; /** @description Recipient name. */ name?: string; - /** @description Recipient phone (including extension). */ + /** + * @nullable + * @description Recipient phone (including extension). + */ phone?: string | null; - /** @description The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. */ + /** + * @nullable + * @description The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. + */ tracking_number?: string | null; }; /** @@ -23810,13 +28374,19 @@ export interface components { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ active: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. */ + /** + * @nullable + * @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. + */ delivery_estimate?: components["schemas"]["shipping_rate_delivery_estimate"] | null; - /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ + /** + * @nullable + * @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. + */ display_name?: string | null; fixed_amount?: components["schemas"]["shipping_rate_fixed_amount"]; /** @description Unique identifier for the object. */ @@ -23833,11 +28403,15 @@ export interface components { */ object: "shipping_rate"; /** + * @nullable * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string|null} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified" | null; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. */ + /** + * @nullable + * @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. + */ tax_code?: (string | components["schemas"]["tax_code"]) | null; /** * @description The type of calculation to use on the shipping rate. @@ -23857,9 +28431,15 @@ export interface components { }; /** ShippingRateDeliveryEstimate */ shipping_rate_delivery_estimate: { - /** @description The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. */ + /** + * @nullable + * @description The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. + */ maximum?: components["schemas"]["shipping_rate_delivery_estimate_bound"] | null; - /** @description The lower bound of the estimated range. If empty, represents no lower bound. */ + /** + * @nullable + * @description The lower bound of the estimated range. If empty, represents no lower bound. + */ minimum?: components["schemas"]["shipping_rate_delivery_estimate_bound"] | null; }; /** ShippingRateDeliveryEstimateBound */ @@ -23877,8 +28457,8 @@ export interface components { /** @description A non-negative integer in cents representing how much to charge. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ @@ -23910,11 +28490,15 @@ export interface components { acss_debit?: components["schemas"]["source_type_acss_debit"]; alipay?: components["schemas"]["source_type_alipay"]; /** + * @nullable * @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. * @enum {string|null} */ allow_redisplay?: "always" | "limited" | "unspecified" | null; - /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. */ + /** + * @nullable + * @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. + */ amount?: number | null; au_becs_debit?: components["schemas"]["source_type_au_becs_debit"]; bancontact?: components["schemas"]["source_type_bancontact"]; @@ -23924,13 +28508,14 @@ export interface components { client_secret: string; code_verification?: components["schemas"]["source_code_verification_flow"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency + * @nullable * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. + * @format currency */ currency?: string | null; /** @description The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. */ @@ -23945,7 +28530,10 @@ export interface components { klarna?: components["schemas"]["source_type_klarna"]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -23955,7 +28543,10 @@ export interface components { * @enum {string} */ object: "source"; - /** @description Information about the owner of the payment instrument that may be used or required by particular source types. */ + /** + * @nullable + * @description Information about the owner of the payment instrument that may be used or required by particular source types. + */ owner?: components["schemas"]["source_owner"] | null; p24?: components["schemas"]["source_type_p24"]; receiver?: components["schemas"]["source_receiver_flow"]; @@ -23963,7 +28554,10 @@ export interface components { sepa_debit?: components["schemas"]["source_type_sepa_debit"]; sofort?: components["schemas"]["source_type_sofort"]; source_order?: components["schemas"]["source_order"]; - /** @description Extra information about a source. This will appear on your customer's statement every time you charge the source. */ + /** + * @nullable + * @description Extra information about a source. This will appear on your customer's statement every time you charge the source. + */ statement_descriptor?: string | null; /** @description The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ status: string; @@ -23973,7 +28567,10 @@ export interface components { * @enum {string} */ type: "ach_credit_transfer" | "ach_debit" | "acss_debit" | "alipay" | "au_becs_debit" | "bancontact" | "card" | "card_present" | "eps" | "giropay" | "ideal" | "klarna" | "multibanco" | "p24" | "sepa_debit" | "sofort" | "three_d_secure" | "wechat"; - /** @description Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. */ + /** + * @nullable + * @description Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. + */ usage?: string | null; wechat?: components["schemas"]["source_type_wechat"]; }; @@ -23992,12 +28589,15 @@ export interface components { */ source_mandate_notification: { acss_debit?: components["schemas"]["source_mandate_notification_acss_debit_data"]; - /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`. */ + /** + * @nullable + * @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`. + */ amount?: number | null; bacs_debit?: components["schemas"]["source_mandate_notification_bacs_debit_data"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ @@ -24042,53 +28642,98 @@ export interface components { /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The email address of the customer placing the order. */ email?: string; - /** @description List of items constituting the order. */ + /** + * @nullable + * @description List of items constituting the order. + */ items?: components["schemas"]["source_order_item"][] | null; shipping?: components["schemas"]["shipping"]; }; /** SourceOrderItem */ source_order_item: { - /** @description The amount (price) for this order item. */ + /** + * @nullable + * @description The amount (price) for this order item. + */ amount?: number | null; - /** @description This currency of this order item. Required when `amount` is present. */ + /** + * @nullable + * @description This currency of this order item. Required when `amount` is present. + */ currency?: string | null; - /** @description Human-readable description for this order item. */ + /** + * @nullable + * @description Human-readable description for this order item. + */ description?: string | null; - /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ + /** + * @nullable + * @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). + */ parent?: string | null; /** @description The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ quantity?: number; - /** @description The type of this order item. Must be `sku`, `tax`, or `shipping`. */ + /** + * @nullable + * @description The type of this order item. Must be `sku`, `tax`, or `shipping`. + */ type?: string | null; }; /** SourceOwner */ source_owner: { - /** @description Owner's address. */ + /** + * @nullable + * @description Owner's address. + */ address?: components["schemas"]["address"] | null; - /** @description Owner's email address. */ + /** + * @nullable + * @description Owner's email address. + */ email?: string | null; - /** @description Owner's full name. */ + /** + * @nullable + * @description Owner's full name. + */ name?: string | null; - /** @description Owner's phone number (including extension). */ + /** + * @nullable + * @description Owner's phone number (including extension). + */ phone?: string | null; - /** @description Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ verified_address?: components["schemas"]["address"] | null; - /** @description Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ verified_email?: string | null; - /** @description Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ verified_name?: string | null; - /** @description Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /** + * @nullable + * @description Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. + */ verified_phone?: string | null; }; /** SourceReceiverFlow */ source_receiver_flow: { - /** @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ + /** + * @nullable + * @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. + */ address?: string | null; /** @description The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. */ amount_charged: number; @@ -24103,7 +28748,10 @@ export interface components { }; /** SourceRedirectFlow */ source_redirect_flow: { - /** @description The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. */ + /** + * @nullable + * @description The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. + */ failure_reason?: string | null; /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ return_url: string; @@ -24125,13 +28773,13 @@ export interface components { amount: number; chf_credit_transfer?: components["schemas"]["source_transaction_chf_credit_transfer_data"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; gbp_credit_transfer?: components["schemas"]["source_transaction_gbp_credit_transfer_data"]; @@ -24214,112 +28862,184 @@ export interface components { sender_name?: string; }; source_type_ach_credit_transfer: { + /** @nullable */ account_number?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ refund_account_holder_name?: string | null; + /** @nullable */ refund_account_holder_type?: string | null; + /** @nullable */ refund_routing_number?: string | null; + /** @nullable */ routing_number?: string | null; + /** @nullable */ swift_code?: string | null; }; source_type_ach_debit: { + /** @nullable */ bank_name?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ routing_number?: string | null; + /** @nullable */ type?: string | null; }; source_type_acss_debit: { + /** @nullable */ bank_address_city?: string | null; + /** @nullable */ bank_address_line_1?: string | null; + /** @nullable */ bank_address_line_2?: string | null; + /** @nullable */ bank_address_postal_code?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ category?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ routing_number?: string | null; }; source_type_alipay: { + /** @nullable */ data_string?: string | null; + /** @nullable */ native_url?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_au_becs_debit: { + /** @nullable */ bsb_number?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ last4?: string | null; }; source_type_bancontact: { + /** @nullable */ bank_code?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ bic?: string | null; + /** @nullable */ iban_last4?: string | null; + /** @nullable */ preferred_language?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_card: { + /** @nullable */ address_line1_check?: string | null; + /** @nullable */ address_zip_check?: string | null; + /** @nullable */ brand?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ cvc_check?: string | null; + /** @nullable */ dynamic_last4?: string | null; + /** @nullable */ exp_month?: number | null; + /** @nullable */ exp_year?: number | null; fingerprint?: string; + /** @nullable */ funding?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ name?: string | null; three_d_secure?: string; + /** @nullable */ tokenization_method?: string | null; }; source_type_card_present: { application_cryptogram?: string; application_preferred_name?: string; + /** @nullable */ authorization_code?: string | null; authorization_response_code?: string; + /** @nullable */ brand?: string | null; + /** @nullable */ country?: string | null; cvm_type?: string; + /** @nullable */ data_type?: string | null; dedicated_file_name?: string; emv_auth_data?: string; + /** @nullable */ evidence_customer_signature?: string | null; + /** @nullable */ evidence_transaction_certificate?: string | null; + /** @nullable */ exp_month?: number | null; + /** @nullable */ exp_year?: number | null; fingerprint?: string; + /** @nullable */ funding?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ pos_device_id?: string | null; pos_entry_mode?: string; + /** @nullable */ read_method?: string | null; + /** @nullable */ reader?: string | null; terminal_verification_results?: string; transaction_status_information?: string; }; source_type_eps: { + /** @nullable */ reference?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_giropay: { + /** @nullable */ bank_code?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ bic?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_ideal: { + /** @nullable */ bank?: string | null; + /** @nullable */ bic?: string | null; + /** @nullable */ iban_last4?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_klarna: { background_image_url?: string; + /** @nullable */ client_token?: string | null; first_name?: string; last_name?: string; @@ -24347,59 +29067,100 @@ export interface components { shipping_last_name?: string; }; source_type_multibanco: { + /** @nullable */ entity?: string | null; + /** @nullable */ reference?: string | null; + /** @nullable */ refund_account_holder_address_city?: string | null; + /** @nullable */ refund_account_holder_address_country?: string | null; + /** @nullable */ refund_account_holder_address_line1?: string | null; + /** @nullable */ refund_account_holder_address_line2?: string | null; + /** @nullable */ refund_account_holder_address_postal_code?: string | null; + /** @nullable */ refund_account_holder_address_state?: string | null; + /** @nullable */ refund_account_holder_name?: string | null; + /** @nullable */ refund_iban?: string | null; }; source_type_p24: { + /** @nullable */ reference?: string | null; }; source_type_sepa_debit: { + /** @nullable */ bank_code?: string | null; + /** @nullable */ branch_code?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ fingerprint?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ mandate_reference?: string | null; + /** @nullable */ mandate_url?: string | null; }; source_type_sofort: { + /** @nullable */ bank_code?: string | null; + /** @nullable */ bank_name?: string | null; + /** @nullable */ bic?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ iban_last4?: string | null; + /** @nullable */ preferred_language?: string | null; + /** @nullable */ statement_descriptor?: string | null; }; source_type_three_d_secure: { + /** @nullable */ address_line1_check?: string | null; + /** @nullable */ address_zip_check?: string | null; + /** @nullable */ authenticated?: boolean | null; + /** @nullable */ brand?: string | null; + /** @nullable */ card?: string | null; + /** @nullable */ country?: string | null; + /** @nullable */ customer?: string | null; + /** @nullable */ cvc_check?: string | null; + /** @nullable */ dynamic_last4?: string | null; + /** @nullable */ exp_month?: number | null; + /** @nullable */ exp_year?: number | null; fingerprint?: string; + /** @nullable */ funding?: string | null; + /** @nullable */ last4?: string | null; + /** @nullable */ name?: string | null; three_d_secure?: string; + /** @nullable */ tokenization_method?: string | null; }; source_type_wechat: { prepay_id?: string; + /** @nullable */ qr_code_url?: string | null; statement_descriptor?: string; }; @@ -24410,33 +29171,50 @@ export interface components { * Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating) */ subscription: { - /** @description ID of the Connect Application that created the subscription. */ + /** + * @nullable + * @description ID of the Connect Application that created the subscription. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. + */ application_fee_percent?: number | null; automatic_tax: components["schemas"]["subscription_automatic_tax"]; /** - * Format: unix-time * @description The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. + * @format unix-time */ billing_cycle_anchor: number; - /** @description The fixed values used to calculate the `billing_cycle_anchor`. */ + /** + * @nullable + * @description The fixed values used to calculate the `billing_cycle_anchor`. + */ billing_cycle_anchor_config?: components["schemas"]["subscriptions_resource_billing_cycle_anchor_config"] | null; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_billing_thresholds"] | null; /** - * Format: unix-time + * @nullable * @description A date in the future at which the subscription will automatically get canceled + * @format unix-time */ cancel_at?: number | null; /** @description Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. */ cancel_at_period_end: boolean; /** - * Format: unix-time + * @nullable * @description If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. + * @format unix-time */ canceled_at?: number | null; - /** @description Details about why this subscription was cancelled */ + /** + * @nullable + * @description Details about why this subscription was cancelled + */ cancellation_details?: components["schemas"]["cancellation_details"] | null; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. @@ -24444,44 +29222,63 @@ export interface components { */ collection_method: "charge_automatically" | "send_invoice"; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** - * Format: unix-time * @description End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. + * @format unix-time */ current_period_end: number; /** - * Format: unix-time * @description Start of the current period that the subscription has been invoiced for. + * @format unix-time */ current_period_start: number; /** @description ID of the customer who owns the subscription. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; - /** @description Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. */ + /** + * @nullable + * @description Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. + */ days_until_due?: number | null; - /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** + * @nullable + * @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** + * @nullable + * @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + */ default_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. */ + /** + * @nullable + * @description The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. + */ default_tax_rates?: components["schemas"]["tax_rate"][] | null; - /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. + */ description?: string | null; - /** @description Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ + /** + * @nullable + * @description Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. + */ discount?: components["schemas"]["discount"] | null; /** @description The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ discounts: (string | components["schemas"]["discount"])[]; /** - * Format: unix-time + * @nullable * @description If the subscription has ended, the date the subscription ended. + * @format unix-time */ ended_at?: number | null; /** @description Unique identifier for the object. */ @@ -24504,7 +29301,10 @@ export interface components { /** @description The URL where this list can be accessed. */ url: string; }; - /** @description The most recent invoice this subscription has generated. */ + /** + * @nullable + * @description The most recent invoice this subscription has generated. + */ latest_invoice?: (string | components["schemas"]["invoice"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -24513,8 +29313,9 @@ export interface components { [key: string]: string; }; /** - * Format: unix-time + * @nullable * @description Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. + * @format unix-time */ next_pending_invoice_item_invoice?: number | null; /** @@ -24522,23 +29323,44 @@ export interface components { * @enum {string} */ object: "subscription"; - /** @description The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. */ + /** + * @nullable + * @description The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). */ + /** + * @nullable + * @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). + */ pause_collection?: components["schemas"]["subscriptions_resource_pause_collection"] | null; - /** @description Payment settings passed on to invoices created by the subscription. */ + /** + * @nullable + * @description Payment settings passed on to invoices created by the subscription. + */ payment_settings?: components["schemas"]["subscriptions_resource_payment_settings"] | null; - /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. */ + /** + * @nullable + * @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. + */ pending_invoice_item_interval?: components["schemas"]["subscription_pending_invoice_item_interval"] | null; - /** @description You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). */ + /** + * @nullable + * @description You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). + */ pending_setup_intent?: (string | components["schemas"]["setup_intent"]) | null; - /** @description If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. */ + /** + * @nullable + * @description If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. + */ pending_update?: components["schemas"]["subscriptions_resource_pending_update"] | null; - /** @description The schedule attached to the subscription */ + /** + * @nullable + * @description The schedule attached to the subscription + */ schedule?: (string | components["schemas"]["subscription_schedule"]) | null; /** - * Format: unix-time * @description Date when the subscription was first created. The date might differ from the `created` date due to backdating. + * @format unix-time */ start_date: number; /** @@ -24556,45 +29378,67 @@ export interface components { * @enum {string} */ status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid"; - /** @description ID of the test clock this subscription belongs to. */ + /** + * @nullable + * @description ID of the test clock this subscription belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; - /** @description The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ + /** + * @nullable + * @description The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. + */ transfer_data?: components["schemas"]["subscription_transfer_data"] | null; /** - * Format: unix-time + * @nullable * @description If the subscription has a trial, the end of that trial. + * @format unix-time */ trial_end?: number | null; - /** @description Settings related to subscription trials. */ + /** + * @nullable + * @description Settings related to subscription trials. + */ trial_settings?: components["schemas"]["subscriptions_trials_resource_trial_settings"] | null; /** - * Format: unix-time + * @nullable * @description If the subscription has a trial, the beginning of that trial. + * @format unix-time */ trial_start?: number | null; }; /** SubscriptionAutomaticTax */ subscription_automatic_tax: { /** + * @nullable * @description If Stripe disabled automatic tax, this enum describes why. * @enum {string|null} */ disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on this subscription. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; }; /** SubscriptionBillingThresholds */ subscription_billing_thresholds: { - /** @description Monetary threshold that triggers the subscription to create an invoice */ + /** + * @nullable + * @description Monetary threshold that triggers the subscription to create an invoice + */ amount_gte?: number | null; - /** @description Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. */ + /** + * @nullable + * @description Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. + */ reset_billing_cycle_anchor?: boolean | null; }; /** SubscriptionDetailsData */ subscription_details_data: { /** + * @nullable * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. * *Note: This attribute is populated only for invoices created on or after June 29, 2023.* */ @@ -24608,7 +29452,10 @@ export interface components { * one plan, making it easy to represent complex billing relationships. */ subscription_item: { - /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_item_billing_thresholds"] | null; /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; @@ -24630,23 +29477,31 @@ export interface components { quantity?: number; /** @description The `subscription` this `subscription_item` belongs to. */ subscription: string; - /** @description The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. */ + /** + * @nullable + * @description The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. + */ tax_rates?: components["schemas"]["tax_rate"][] | null; }; /** SubscriptionItemBillingThresholds */ subscription_item_billing_thresholds: { - /** @description Usage threshold that triggers the subscription to create an invoice */ + /** + * @nullable + * @description Usage threshold that triggers the subscription to create an invoice + */ usage_gte?: number | null; }; /** subscription_payment_method_options_card */ subscription_payment_method_options_card: { mandate_options?: components["schemas"]["invoice_mandate_options_card"]; /** + * @nullable * @description Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. * @enum {string|null} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** + * @nullable * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ @@ -24669,24 +29524,32 @@ export interface components { * Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules) */ subscription_schedule: { - /** @description ID of the Connect Application that created the schedule. */ + /** + * @nullable + * @description ID of the Connect Application that created the schedule. + */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; /** - * Format: unix-time + * @nullable * @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. + * @format unix-time */ completed_at?: number | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. */ + /** + * @nullable + * @description Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. + */ current_phase?: components["schemas"]["subscription_schedule_current_phase"] | null; /** @description ID of the customer who owns the subscription schedule. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; @@ -24700,7 +29563,10 @@ export interface components { id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -24712,20 +29578,30 @@ export interface components { /** @description Configuration for the subscription schedule's phases. */ phases: components["schemas"]["subscription_schedule_phase_configuration"][]; /** - * Format: unix-time + * @nullable * @description Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. + * @format unix-time */ released_at?: number | null; - /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ + /** + * @nullable + * @description ID of the subscription once managed by the subscription schedule (if it is released). + */ released_subscription?: string | null; /** * @description The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). * @enum {string} */ status: "active" | "canceled" | "completed" | "not_started" | "released"; - /** @description ID of the subscription managed by the subscription schedule. */ + /** + * @nullable + * @description ID of the subscription managed by the subscription schedule. + */ subscription?: (string | components["schemas"]["subscription"]) | null; - /** @description ID of the test clock this subscription schedule belongs to. */ + /** + * @nullable + * @description ID of the test clock this subscription schedule belongs to. + */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; }; /** @@ -24737,9 +29613,15 @@ export interface components { discounts: components["schemas"]["discounts_resource_stackable_discount"][]; /** @description ID of the price used to generate the invoice item. */ price: string | components["schemas"]["price"] | components["schemas"]["deleted_price"]; - /** @description The quantity of the invoice item. */ + /** + * @nullable + * @description The quantity of the invoice item. + */ quantity?: number | null; - /** @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. */ + /** + * @nullable + * @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. + */ tax_rates?: components["schemas"]["tax_rate"][] | null; }; /** @@ -24747,11 +29629,17 @@ export interface components { * @description A phase item describes the price and quantity of a phase. */ subscription_schedule_configuration_item: { - /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_item_billing_thresholds"] | null; /** @description The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ discounts: components["schemas"]["discounts_resource_stackable_discount"][]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. + */ metadata?: { [key: string]: string; } | null; @@ -24759,19 +29647,22 @@ export interface components { price: string | components["schemas"]["price"] | components["schemas"]["deleted_price"]; /** @description Quantity of the plan to which the customer should be subscribed. */ quantity?: number; - /** @description The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`. */ + /** + * @nullable + * @description The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`. + */ tax_rates?: components["schemas"]["tax_rate"][] | null; }; /** SubscriptionScheduleCurrentPhase */ subscription_schedule_current_phase: { /** - * Format: unix-time * @description The end of this phase of the subscription schedule. + * @format unix-time */ end_date: number; /** - * Format: unix-time * @description The start of this phase of the subscription schedule. + * @format unix-time */ start_date: number; }; @@ -24782,50 +29673,79 @@ export interface components { subscription_schedule_phase_configuration: { /** @description A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. */ add_invoice_items: components["schemas"]["subscription_schedule_add_invoice_item"][]; - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. + */ application_fee_percent?: number | null; automatic_tax?: components["schemas"]["schedules_phase_automatic_tax"]; /** + * @nullable * @description Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string|null} */ billing_cycle_anchor?: "automatic" | "phase_start" | null; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_billing_thresholds"] | null; /** + * @nullable * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. * @enum {string|null} */ collection_method?: "charge_automatically" | "send_invoice" | null; - /** @description ID of the coupon to use during this phase of the subscription schedule. */ + /** + * @nullable + * @description ID of the coupon to use during this phase of the subscription schedule. + */ coupon?: (string | components["schemas"]["coupon"] | components["schemas"]["deleted_coupon"]) | null; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. */ + /** + * @nullable + * @description ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. + */ 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. */ + /** + * @nullable + * @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 for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @description Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. + */ description?: string | null; /** @description The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts. */ discounts: components["schemas"]["discounts_resource_stackable_discount"][]; /** - * Format: unix-time * @description The end of this phase of the subscription schedule. + * @format unix-time */ end_date: number; - /** @description The invoice settings applicable during this phase. */ + /** + * @nullable + * @description The invoice settings applicable during this phase. + */ invoice_settings?: components["schemas"]["invoice_setting_subscription_schedule_phase_setting"] | null; /** @description Subscription items to configure the subscription to during this phase of the subscription schedule. */ items: components["schemas"]["subscription_schedule_configuration_item"][]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. + */ metadata?: { [key: string]: string; } | null; - /** @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. */ + /** + * @nullable + * @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** * @description If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. @@ -24833,21 +29753,28 @@ export interface components { */ proration_behavior: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description The start of this phase of the subscription schedule. + * @format unix-time */ start_date: number; - /** @description The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ + /** + * @nullable + * @description The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. + */ transfer_data?: components["schemas"]["subscription_transfer_data"] | null; /** - * Format: unix-time + * @nullable * @description When the trial ends within the phase. + * @format unix-time */ trial_end?: number | null; }; /** SubscriptionSchedulesResourceDefaultSettings */ subscription_schedules_resource_default_settings: { - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. + */ application_fee_percent?: number | null; automatic_tax?: components["schemas"]["subscription_schedules_resource_default_settings_automatic_tax"]; /** @@ -24855,38 +29782,61 @@ export interface components { * @enum {string} */ billing_cycle_anchor: "automatic" | "phase_start"; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ + /** + * @nullable + * @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + */ billing_thresholds?: components["schemas"]["subscription_billing_thresholds"] | null; /** + * @nullable * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. * @enum {string|null} */ collection_method?: "charge_automatically" | "send_invoice" | null; - /** @description ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. */ + /** + * @nullable + * @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 for rendering in Stripe surfaces and certain local payment methods UIs. */ + /** + * @nullable + * @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; invoice_settings: components["schemas"]["invoice_setting_subscription_schedule_setting"]; - /** @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. */ + /** + * @nullable + * @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ + /** + * @nullable + * @description The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. + */ transfer_data?: components["schemas"]["subscription_transfer_data"] | null; }; /** SubscriptionSchedulesResourceDefaultSettingsAutomaticTax */ subscription_schedules_resource_default_settings_automatic_tax: { /** + * @nullable * @description If Stripe disabled automatic tax, this enum describes why. * @enum {string|null} */ disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ enabled: boolean; - /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ + /** + * @nullable + * @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. + */ liability?: components["schemas"]["connect_account_reference"] | null; }; /** SubscriptionTransferData */ subscription_transfer_data: { - /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ + /** + * @nullable + * @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + */ amount_percent?: number | null; /** @description The account where funds from the payment will be transferred to upon payment success. */ destination: string | components["schemas"]["account"]; @@ -24895,13 +29845,25 @@ export interface components { subscriptions_resource_billing_cycle_anchor_config: { /** @description The day of the month of the billing_cycle_anchor. */ day_of_month: number; - /** @description The hour of the day of the billing_cycle_anchor. */ + /** + * @nullable + * @description The hour of the day of the billing_cycle_anchor. + */ hour?: number | null; - /** @description The minute of the hour of the billing_cycle_anchor. */ + /** + * @nullable + * @description The minute of the hour of the billing_cycle_anchor. + */ minute?: number | null; - /** @description The month to start full cycle billing periods. */ + /** + * @nullable + * @description The month to start full cycle billing periods. + */ month?: number | null; - /** @description The second of the minute of the billing_cycle_anchor. */ + /** + * @nullable + * @description The second of the minute of the billing_cycle_anchor. + */ second?: number | null; }; /** @@ -24916,35 +29878,64 @@ export interface components { */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; /** - * Format: unix-time + * @nullable * @description The time after which the subscription will resume collecting payments. + * @format unix-time */ resumes_at?: number | null; }; /** SubscriptionsResourcePaymentMethodOptions */ subscriptions_resource_payment_method_options: { - /** @description This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. + */ acss_debit?: components["schemas"]["invoice_payment_method_options_acss_debit"] | null; - /** @description This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. + */ bancontact?: components["schemas"]["invoice_payment_method_options_bancontact"] | null; - /** @description This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. + */ card?: components["schemas"]["subscription_payment_method_options_card"] | null; - /** @description This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription. + */ customer_balance?: components["schemas"]["invoice_payment_method_options_customer_balance"] | null; - /** @description This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. + */ konbini?: components["schemas"]["invoice_payment_method_options_konbini"] | null; - /** @description This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription. + */ sepa_debit?: components["schemas"]["invoice_payment_method_options_sepa_debit"] | null; - /** @description This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription. */ + /** + * @nullable + * @description This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription. + */ us_bank_account?: components["schemas"]["invoice_payment_method_options_us_bank_account"] | null; }; /** SubscriptionsResourcePaymentSettings */ subscriptions_resource_payment_settings: { - /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ + /** + * @nullable + * @description Payment-method-specific configuration to provide to invoices created by the subscription. + */ payment_method_options?: components["schemas"]["subscriptions_resource_payment_method_options"] | null; - /** @description The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ + /** + * @nullable + * @description The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). + */ payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; /** + * @nullable * @description Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`. * @enum {string|null} */ @@ -24957,28 +29948,39 @@ export interface components { */ subscriptions_resource_pending_update: { /** - * Format: unix-time + * @nullable * @description If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. + * @format unix-time */ billing_cycle_anchor?: number | null; /** - * Format: unix-time * @description The point after which the changes reflected by this update will be discarded and no longer applied. + * @format unix-time */ expires_at: number; - /** @description List of subscription items, each with an attached plan, that will be set if the update is applied. */ + /** + * @nullable + * @description List of subscription items, each with an attached plan, that will be set if the update is applied. + */ subscription_items?: components["schemas"]["subscription_item"][] | null; /** - * Format: unix-time + * @nullable * @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. + * @format unix-time */ trial_end?: number | null; - /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** + * @nullable + * @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. + */ trial_from_plan?: boolean | null; }; /** SubscriptionsResourceSubscriptionInvoiceSettings */ subscriptions_resource_subscription_invoice_settings: { - /** @description The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription. */ + /** + * @nullable + * @description The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription. + */ account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; issuer: components["schemas"]["connect_account_reference"]; }; @@ -25011,18 +30013,26 @@ export interface components { amount_total: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; - /** @description The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. */ + /** + * @nullable + * @description The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. + */ customer?: string | null; customer_details: components["schemas"]["tax_product_resource_customer_details"]; /** - * Format: unix-time + * @nullable * @description Timestamp of date at which the tax calculation will expire. + * @format unix-time */ expires_at?: number | null; - /** @description Unique identifier for the calculation. */ + /** + * @nullable + * @description Unique identifier for the calculation. + */ id?: string | null; /** * TaxProductResourceTaxCalculationLineItemList + * @nullable * @description The list of items the customer is purchasing. */ line_items?: { @@ -25035,7 +30045,10 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/calculations/[^/]+/line_items + */ url: string; } | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -25045,9 +30058,15 @@ export interface components { * @enum {string} */ object: "tax.calculation"; - /** @description The details of the ship from location, such as the address. */ + /** + * @nullable + * @description The details of the ship from location, such as the address. + */ ship_from_details?: components["schemas"]["tax_product_resource_ship_from_details"] | null; - /** @description The shipping cost details for the calculation. */ + /** + * @nullable + * @description The shipping cost details for the calculation. + */ shipping_cost?: components["schemas"]["tax_product_resource_tax_calculation_shipping_cost"] | null; /** @description The amount of tax to be collected on top of the line item prices. */ tax_amount_exclusive: number; @@ -25056,8 +30075,8 @@ export interface components { /** @description Breakdown of individual tax amounts that add up to the total. */ tax_breakdown: components["schemas"]["tax_product_resource_tax_breakdown"][]; /** - * Format: unix-time * @description Timestamp of date at which the tax rules and rates in effect applies for the calculation. + * @format unix-time */ tax_date: number; }; @@ -25076,18 +30095,27 @@ export interface components { * @enum {string} */ object: "tax.calculation_line_item"; - /** @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). */ + /** + * @nullable + * @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). + */ product?: string | null; /** @description The number of units of the item being purchased. For reversals, this is the quantity reversed. */ quantity: number; - /** @description A custom identifier for this line item. */ + /** + * @nullable + * @description A custom identifier for this line item. + */ reference?: string | null; /** * @description Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. * @enum {string} */ tax_behavior: "exclusive" | "inclusive"; - /** @description Detailed account of taxes relevant to this line item. */ + /** + * @nullable + * @description Detailed account of taxes relevant to this line item. + */ tax_breakdown?: components["schemas"]["tax_product_resource_line_item_tax_breakdown"][] | null; /** @description The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. */ tax_code: string; @@ -25102,21 +30130,22 @@ export interface components { */ "tax.registration": { /** - * Format: unix-time * @description Time at which the registration becomes active. Measured in seconds since the Unix epoch. + * @format unix-time */ 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. + * @format unix-time */ created: number; /** - * Format: unix-time + * @nullable * @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 */ expires_at?: number | null; /** @description Unique identifier for the object. */ @@ -25142,7 +30171,10 @@ export interface components { */ "tax.settings": { defaults: components["schemas"]["tax_product_resource_tax_settings_defaults"]; - /** @description The place where your business is located. */ + /** + * @nullable + * @description The place where your business is located. + */ head_office?: components["schemas"]["tax_product_resource_tax_settings_head_office"] | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -25166,19 +30198,23 @@ export interface components { */ "tax.transaction": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; - /** @description The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. */ + /** + * @nullable + * @description The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. + */ customer?: string | null; customer_details: components["schemas"]["tax_product_resource_customer_details"]; /** @description Unique identifier for the transaction. */ id: string; /** * TaxProductResourceTaxTransactionLineItemList + * @nullable * @description The tax collected or refunded, by line item. */ line_items?: { @@ -25191,12 +30227,18 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/transactions/[^/]+/line_items + */ url: string; } | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -25206,21 +30248,30 @@ export interface components { */ object: "tax.transaction"; /** - * Format: unix-time * @description The Unix timestamp representing when the tax liability is assumed or reduced. + * @format unix-time */ posted_at: number; /** @description A custom unique identifier, such as 'myOrder_123'. */ reference: string; - /** @description If `type=reversal`, contains information about what was reversed. */ + /** + * @nullable + * @description If `type=reversal`, contains information about what was reversed. + */ reversal?: components["schemas"]["tax_product_resource_tax_transaction_resource_reversal"] | null; - /** @description The details of the ship from location, such as the address. */ + /** + * @nullable + * @description The details of the ship from location, such as the address. + */ ship_from_details?: components["schemas"]["tax_product_resource_ship_from_details"] | null; - /** @description The shipping cost details for the transaction. */ + /** + * @nullable + * @description The shipping cost details for the transaction. + */ shipping_cost?: components["schemas"]["tax_product_resource_tax_transaction_shipping_cost"] | null; /** - * Format: unix-time * @description Timestamp of date at which the tax rules and rates in effect applies for the calculation. + * @format unix-time */ tax_date: number; /** @@ -25239,7 +30290,10 @@ export interface components { id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -25248,13 +30302,19 @@ export interface components { * @enum {string} */ object: "tax.transaction_line_item"; - /** @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). */ + /** + * @nullable + * @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). + */ product?: string | null; /** @description The number of units of the item being purchased. For reversals, this is the quantity reversed. */ quantity: number; /** @description A custom identifier for this line item in the transaction. */ reference: string; - /** @description If `type=reversal`, contains information about what was reversed. */ + /** + * @nullable + * @description If `type=reversal`, contains information about what was reversed. + */ reversal?: components["schemas"]["tax_product_resource_tax_transaction_line_item_resource_reversal"] | null; /** * @description Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. @@ -25296,13 +30356,13 @@ export interface components { */ object: "tax_deducted_at_source"; /** - * Format: unix-time * @description The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. + * @format unix-time */ period_end: number; /** - * Format: unix-time * @description The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. + * @format unix-time */ period_start: number; /** @description The TAN that was supplied to Stripe when TDS was assessed */ @@ -25330,14 +30390,20 @@ export interface components { * Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids) */ tax_id: { - /** @description Two-letter ISO code representing the country of the tax ID. */ + /** + * @nullable + * @description Two-letter ISO code representing the country of the tax ID. + */ country?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description ID of the customer. */ + /** + * @nullable + * @description ID of the customer. + */ customer?: (string | components["schemas"]["customer"]) | null; /** @description Unique identifier for the object. */ id: string; @@ -25348,7 +30414,10 @@ export interface components { * @enum {string} */ object: "tax_id"; - /** @description The account or customer the tax ID belongs to. */ + /** + * @nullable + * @description The account or customer the tax ID belongs to. + */ owner?: components["schemas"]["tax_i_ds_owner"] | null; /** * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` @@ -25357,7 +30426,10 @@ export interface components { type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; - /** @description Tax ID verification information. */ + /** + * @nullable + * @description Tax ID verification information. + */ verification?: components["schemas"]["tax_id_verification"] | null; }; /** tax_id_verification */ @@ -25367,9 +30439,15 @@ export interface components { * @enum {string} */ status: "pending" | "unavailable" | "unverified" | "verified"; - /** @description Verified address. */ + /** + * @nullable + * @description Verified address. + */ verified_address?: string | null; - /** @description Verified name. */ + /** + * @nullable + * @description Verified name. + */ verified_name?: string | null; }; /** TaxProductRegistrationsResourceCountryOptions */ @@ -25548,14 +30626,21 @@ export interface components { }; /** TaxProductResourceCustomerDetails */ tax_product_resource_customer_details: { - /** @description The customer's postal address (for example, home or business location). */ + /** + * @nullable + * @description The customer's postal address (for example, home or business location). + */ address?: components["schemas"]["tax_product_resource_postal_address"] | null; /** + * @nullable * @description The type of customer address provided. * @enum {string|null} */ address_source?: "billing" | "shipping" | null; - /** @description The customer's IP address (IPv4 or IPv6). */ + /** + * @nullable + * @description The customer's IP address (IPv4 or IPv6). + */ ip_address?: string | null; /** @description The customer's tax IDs (for example, EU VAT numbers). */ tax_ids: components["schemas"]["tax_product_resource_customer_details_resource_tax_id"][]; @@ -25586,7 +30671,10 @@ export interface components { * @enum {string} */ level: "city" | "country" | "county" | "district" | "state"; - /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ + /** + * @nullable + * @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. + */ state?: string | null; }; /** TaxProductResourceLineItemTaxBreakdown */ @@ -25599,7 +30687,10 @@ export interface components { * @enum {string} */ sourcing: "destination" | "origin"; - /** @description Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax. */ + /** + * @nullable + * @description Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax. + */ tax_rate_details?: components["schemas"]["tax_product_resource_line_item_tax_rate_details"] | null; /** * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. @@ -25623,17 +30714,32 @@ export interface components { }; /** TaxProductResourcePostalAddress */ tax_product_resource_postal_address: { - /** @description City, district, suburb, town, or village. */ + /** + * @nullable + * @description City, district, suburb, town, or village. + */ city?: string | null; /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ country: string; - /** @description Address line 1 (e.g., street, PO Box, or company name). */ + /** + * @nullable + * @description Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string | null; - /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + /** + * @nullable + * @description Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string | null; - /** @description ZIP or postal code. */ + /** + * @nullable + * @description ZIP or postal code. + */ postal_code?: string | null; - /** @description State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". */ + /** + * @nullable + * @description State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". + */ state?: string | null; }; /** TaxProductResourceShipFromDetails */ @@ -25675,20 +30781,31 @@ export interface components { }; /** TaxProductResourceTaxRateDetails */ tax_product_resource_tax_rate_details: { - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; - /** @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. */ + /** + * @nullable + * @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. + */ flat_amount?: components["schemas"]["tax_rate_flat_amount"] | null; /** @description The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`. */ percentage_decimal: string; /** + * @nullable * @description Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. * @enum {string|null} */ rate_type?: "flat_amount" | "percentage" | null; - /** @description State, county, province, or region. */ + /** + * @nullable + * @description State, county, province, or region. + */ state?: string | null; /** + * @nullable * @description The tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ @@ -25697,11 +30814,15 @@ export interface components { /** TaxProductResourceTaxSettingsDefaults */ tax_product_resource_tax_settings_defaults: { /** + * @nullable * @description Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior. * @enum {string|null} */ tax_behavior?: "exclusive" | "inclusive" | "inferred_by_currency" | null; - /** @description Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices. */ + /** + * @nullable + * @description Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices. + */ tax_code?: string | null; }; /** TaxProductResourceTaxSettingsHeadOffice */ @@ -25717,7 +30838,10 @@ export interface components { tax_product_resource_tax_settings_status_details_resource_active: Record; /** TaxProductResourceTaxSettingsStatusDetailsResourcePending */ tax_product_resource_tax_settings_status_details_resource_pending: { - /** @description The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call. */ + /** + * @nullable + * @description The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call. + */ missing_fields?: string[] | null; }; /** TaxProductResourceTaxTransactionLineItemResourceReversal */ @@ -25727,7 +30851,10 @@ export interface components { }; /** TaxProductResourceTaxTransactionResourceReversal */ tax_product_resource_tax_transaction_resource_reversal: { - /** @description The `id` of the reversed `Transaction` object. */ + /** + * @nullable + * @description The `id` of the reversed `Transaction` object. + */ original_transaction?: string | null; }; /** TaxProductResourceTaxTransactionShippingCost */ @@ -25755,39 +30882,56 @@ export interface components { tax_rate: { /** @description Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ active: boolean; - /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /** + * @nullable + * @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ + /** + * @nullable + * @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. + */ description?: string | null; /** @description The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. */ display_name: string; /** + * @nullable * @description Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, * this percentage reflects the rate actually used to calculate tax based on the product's taxability * and whether the user is registered to collect taxes in the corresponding jurisdiction. */ effective_percentage?: number | null; - /** @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. */ + /** + * @nullable + * @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. + */ flat_amount?: components["schemas"]["tax_rate_flat_amount"] | null; /** @description Unique identifier for the object. */ id: string; /** @description This specifies if the tax rate is inclusive or exclusive. */ inclusive: boolean; - /** @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. */ + /** + * @nullable + * @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. + */ jurisdiction?: string | null; /** + * @nullable * @description The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. * @enum {string|null} */ jurisdiction_level?: "city" | "country" | "county" | "district" | "multiple" | "state" | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -25799,13 +30943,18 @@ export interface components { /** @description Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. */ percentage: number; /** + * @nullable * @description Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. * @enum {string|null} */ rate_type?: "flat_amount" | "percentage" | null; - /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ + /** + * @nullable + * @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. + */ state?: string | null; /** + * @nullable * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ @@ -25829,11 +30978,17 @@ export interface components { bbpos_wisepos_e?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; /** @description Unique identifier for the object. */ id: string; - /** @description Whether this Configuration is the default for your account */ + /** + * @nullable + * @description Whether this Configuration is the default for your account + */ is_account_default?: boolean | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description String indicating the name of the Configuration object, set by the user */ + /** + * @nullable + * @description String indicating the name of the Configuration object, set by the user + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -25896,9 +31051,15 @@ export interface components { * Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader) */ "terminal.reader": { - /** @description The most recent action performed by the reader. */ + /** + * @nullable + * @description The most recent action performed by the reader. + */ action?: components["schemas"]["terminal_reader_reader_resource_reader_action"] | null; - /** @description The current software version of the reader. */ + /** + * @nullable + * @description The current software version of the reader. + */ device_sw_version?: string | null; /** * @description Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. @@ -25907,13 +31068,19 @@ export interface components { device_type: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700" | "verifone_P400"; /** @description Unique identifier for the object. */ id: string; - /** @description The local IP address of the reader. */ + /** + * @nullable + * @description The local IP address of the reader. + */ ip_address?: string | null; /** @description Custom label given to the reader for easier identification. */ label: 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 location identifier of the reader. */ + /** + * @nullable + * @description The location identifier of the reader. + */ location?: (string | components["schemas"]["terminal.location"]) | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { @@ -25927,6 +31094,7 @@ export interface components { /** @description Serial number of the reader. */ serial_number: string; /** + * @nullable * @description The networking status of the reader. We do not recommend using this field in flows that may block taking payments. * @enum {string|null} */ @@ -25934,9 +31102,15 @@ export interface components { }; /** TerminalConfigurationConfigurationResourceCurrencySpecificConfig */ terminal_configuration_configuration_resource_currency_specific_config: { - /** @description Fixed amounts displayed when collecting a tip */ + /** + * @nullable + * @description Fixed amounts displayed when collecting a tip + */ fixed_amounts?: number[] | null; - /** @description Percentages displayed when collecting a tip */ + /** + * @nullable + * @description Percentages displayed when collecting a tip + */ percentages?: number[] | null; /** @description Below this amount, fixed amounts will be displayed; above it, percentages will be displayed */ smart_tip_threshold?: number; @@ -25948,7 +31122,10 @@ export interface components { }; /** TerminalConfigurationConfigurationResourceOfflineConfig */ terminal_configuration_configuration_resource_offline_config: { - /** @description Determines whether to allow transactions to be collected while reader is offline. Defaults to false. */ + /** + * @nullable + * @description Determines whether to allow transactions to be collected while reader is offline. Defaults to false. + */ enabled?: boolean | null; }; /** TerminalConfigurationConfigurationResourceRebootWindow */ @@ -25983,13 +31160,16 @@ export interface components { */ terminal_reader_reader_resource_cart: { /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description List of line items in the cart. */ line_items: components["schemas"]["terminal_reader_reader_resource_line_item"][]; - /** @description Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** + * @nullable + * @description Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + */ tax?: number | null; /** @description Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ total: number; @@ -26050,9 +31230,15 @@ export interface components { * @description Represents an action performed by the reader */ terminal_reader_reader_resource_reader_action: { - /** @description Failure code, only set if status is `failed`. */ + /** + * @nullable + * @description Failure code, only set if status is `failed`. + */ failure_code?: string | null; - /** @description Detailed failure message, only set if status is `failed`. */ + /** + * @nullable + * @description Detailed failure message, only set if status is `failed`. + */ failure_message?: string | null; process_payment_intent?: components["schemas"]["terminal_reader_reader_resource_process_payment_intent_action"]; process_setup_intent?: components["schemas"]["terminal_reader_reader_resource_process_setup_intent_action"]; @@ -26110,7 +31296,10 @@ export interface components { * @description Represents a reader action to set the reader display */ terminal_reader_reader_resource_set_reader_display_action: { - /** @description Cart object to be displayed by the reader. */ + /** + * @nullable + * @description Cart object to be displayed by the reader. + */ cart?: components["schemas"]["terminal_reader_reader_resource_cart"] | null; /** * @description Type of information to be displayed by the reader. @@ -26134,25 +31323,28 @@ export interface components { */ "test_helpers.test_clock": { /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: unix-time * @description Time at which this clock is scheduled to auto delete. + * @format unix-time */ deletes_after: number; /** - * Format: unix-time * @description Time at which all objects belonging to this clock are frozen. + * @format unix-time */ frozen_time: number; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description The custom name supplied at creation. */ + /** + * @nullable + * @description The custom name supplied at creation. + */ name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -26169,34 +31361,40 @@ export interface components { /** three_d_secure_details */ three_d_secure_details: { /** + * @nullable * @description For authenticated transactions: how the customer was authenticated by * the issuing bank. * @enum {string|null} */ authentication_flow?: "challenge" | "frictionless" | null; /** + * @nullable * @description The Electronic Commerce Indicator (ECI). A protocol-level field * indicating what degree of authentication was performed. * @enum {string|null} */ electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07" | null; /** + * @nullable * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} */ result?: "attempt_acknowledged" | "authenticated" | "exempted" | "failed" | "not_supported" | "processing_error" | null; /** + * @nullable * @description Additional information about why 3D Secure succeeded or failed based * on the `result`. * @enum {string|null} */ result_reason?: "abandoned" | "bypassed" | "canceled" | "card_not_enrolled" | "network_not_supported" | "protocol_error" | "rejected" | null; /** + * @nullable * @description The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID * (dsTransId) for this payment. */ transaction_id?: string | null; /** + * @nullable * @description The version of 3D Secure that was used. * @enum {string|null} */ @@ -26205,18 +31403,21 @@ export interface components { /** three_d_secure_details_charge */ three_d_secure_details_charge: { /** + * @nullable * @description For authenticated transactions: how the customer was authenticated by * the issuing bank. * @enum {string|null} */ authentication_flow?: "challenge" | "frictionless" | null; /** + * @nullable * @description The Electronic Commerce Indicator (ECI). A protocol-level field * indicating what degree of authentication was performed. * @enum {string|null} */ electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07" | null; /** + * @nullable * @description The exemption requested via 3DS and accepted by the issuer at authentication time. * @enum {string|null} */ @@ -26227,22 +31428,26 @@ export interface components { */ exemption_indicator_applied?: boolean; /** + * @nullable * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} */ result?: "attempt_acknowledged" | "authenticated" | "exempted" | "failed" | "not_supported" | "processing_error" | null; /** + * @nullable * @description Additional information about why 3D Secure succeeded or failed based * on the `result`. * @enum {string|null} */ result_reason?: "abandoned" | "bypassed" | "canceled" | "card_not_enrolled" | "network_not_supported" | "protocol_error" | "rejected" | null; /** + * @nullable * @description The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID * (dsTransId) for this payment. */ transaction_id?: string | null; /** + * @nullable * @description The version of 3D Secure that was used. * @enum {string|null} */ @@ -26255,7 +31460,10 @@ export interface components { }; /** ThresholdsResourceUsageAlertFilter */ thresholds_resource_usage_alert_filter: { - /** @description Limit the scope of the alert to this customer ID */ + /** + * @nullable + * @description Limit the scope of the alert to this customer ID + */ customer?: (string | components["schemas"]["customer"]) | null; /** @enum {string} */ type: "customer"; @@ -26265,7 +31473,10 @@ export interface components { * @description The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed. */ thresholds_resource_usage_threshold_config: { - /** @description The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time. */ + /** + * @nullable + * @description The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time. + */ filters?: components["schemas"]["thresholds_resource_usage_alert_filter"][] | null; /** @description The value at which this alert will trigger. */ gte: number; @@ -26303,11 +31514,14 @@ export interface components { token: { bank_account?: components["schemas"]["bank_account"]; card?: components["schemas"]["card"]; - /** @description IP address of the client that generates the token. */ + /** + * @nullable + * @description IP address of the client that generates the token. + */ client_ip?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Unique identifier for the object. */ @@ -26326,7 +31540,10 @@ export interface components { }; /** token_card_networks */ token_card_networks: { - /** @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. */ + /** + * @nullable + * @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. + */ preferred?: string | null; }; /** @@ -26340,22 +31557,37 @@ export interface components { topup: { /** @description Amount transferred. */ amount: number; - /** @description ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. */ + /** + * @nullable + * @description ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. */ + /** + * @nullable + * @description Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. + */ expected_availability_date?: number | null; - /** @description Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ + /** + * @nullable + * @description Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). + */ failure_code?: string | null; - /** @description Message to user further explaining reason for top-up failure if available. */ + /** + * @nullable + * @description Message to user further explaining reason for top-up failure if available. + */ failure_message?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26370,16 +31602,25 @@ export interface components { * @enum {string} */ object: "topup"; - /** @description The source field is deprecated. It might not always be present in the API response. */ + /** + * @nullable + * @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. */ + /** + * @nullable + * @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; /** * @description The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. * @enum {string} */ status: "canceled" | "failed" | "pending" | "reversed" | "succeeded"; - /** @description A string that identifies this top-up as part of a group. */ + /** + * @nullable + * @description A string that identifies this top-up as part of a group. + */ transfer_group?: string | null; }; /** @@ -26400,21 +31641,30 @@ export interface components { amount: number; /** @description Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ amount_reversed: number; - /** @description Balance transaction that describes the impact of this transfer on your account balance. */ + /** + * @nullable + * @description Balance transaction that describes the impact of this transfer on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time that this record of the transfer was first created. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description ID of the Stripe account the transfer was sent to. */ + /** + * @nullable + * @description ID of the Stripe account the transfer was sent to. + */ destination?: (string | components["schemas"]["account"]) | null; /** @description If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. */ destination_payment?: string | components["schemas"]["charge"]; @@ -26450,11 +31700,17 @@ export interface components { }; /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ reversed: boolean; - /** @description ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance. */ + /** + * @nullable + * @description ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance. + */ source_transaction?: (string | components["schemas"]["charge"]) | null; /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ source_type?: string; - /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /** + * @nullable + * @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. + */ transfer_group?: string | null; }; /** transfer_data */ @@ -26487,23 +31743,32 @@ export interface components { transfer_reversal: { /** @description Amount, in cents (or local equivalent). */ amount: number; - /** @description Balance transaction that describes the impact on your account balance. */ + /** + * @nullable + * @description Balance transaction that describes the impact on your account balance. + */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description Linked payment refund for the transfer reversal. */ + /** + * @nullable + * @description Linked payment refund for the transfer reversal. + */ destination_payment_refund?: (string | components["schemas"]["refund"]) | null; /** @description Unique identifier for the object. */ id: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; @@ -26512,7 +31777,10 @@ export interface components { * @enum {string} */ object: "transfer_reversal"; - /** @description ID of the refund responsible for the transfer reversal. */ + /** + * @nullable + * @description ID of the refund responsible for the transfer reversal. + */ source_refund?: (string | components["schemas"]["refund"]) | null; /** @description ID of the transfer that was reversed. */ transfer: string | components["schemas"]["transfer"]; @@ -26556,18 +31824,21 @@ export interface components { /** @description Amount (in cents) transferred. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The FinancialAccount to reverse funds from. */ financial_account: string; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26595,7 +31866,10 @@ export interface components { */ status: "canceled" | "posted" | "processing"; status_transitions: components["schemas"]["treasury_received_credits_resource_status_transitions"]; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -26606,22 +31880,31 @@ export interface components { /** @description Amount (in cents) transferred. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description The FinancialAccount to reverse funds from. */ + /** + * @nullable + * @description The FinancialAccount to reverse funds from. + */ financial_account?: string | null; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; - /** @description Other flows linked to a DebitReversal. */ + /** + * @nullable + * @description Other flows linked to a DebitReversal. + */ linked_flows?: components["schemas"]["treasury_received_debits_resource_debit_reversal_linked_flows"] | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -26647,7 +31930,10 @@ export interface components { */ status: "failed" | "processing" | "succeeded"; status_transitions: components["schemas"]["treasury_received_debits_resource_status_transitions"]; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -26662,8 +31948,8 @@ export interface components { /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ country: string; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; features?: components["schemas"]["treasury.financial_account_features"]; @@ -26674,11 +31960,17 @@ export interface components { is_default?: boolean; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /** + * @nullable + * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + */ metadata?: { [key: string]: string; } | null; - /** @description The nickname for the FinancialAccount. */ + /** + * @nullable + * @description The nickname for the FinancialAccount. + */ nickname?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -26687,7 +31979,10 @@ export interface components { object: "treasury.financial_account"; /** @description The array of paths to pending Features in the Features hash. */ pending_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; - /** @description The set of functionalities that the platform can restrict on the FinancialAccount. */ + /** + * @nullable + * @description The set of functionalities that the platform can restrict on the FinancialAccount. + */ platform_restrictions?: components["schemas"]["treasury_financial_accounts_resource_platform_restrictions"] | null; /** @description The array of paths to restricted Features in the Features hash. */ restricted_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; @@ -26731,22 +32026,31 @@ export interface components { /** @description Returns `true` if the InboundTransfer is able to be canceled. */ cancelable: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description Details about this InboundTransfer's failure. Only set when status is `failed`. */ + /** + * @nullable + * @description Details about this InboundTransfer's failure. Only set when status is `failed`. + */ failure_details?: components["schemas"]["treasury_inbound_transfers_resource_failure_details"] | null; /** @description The FinancialAccount that received the funds. */ financial_account: string; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26762,11 +32066,20 @@ export interface components { * @enum {string} */ object: "treasury.inbound_transfer"; - /** @description The origin payment method to be debited for an InboundTransfer. */ + /** + * @nullable + * @description The origin payment method to be debited for an InboundTransfer. + */ origin_payment_method?: string | null; - /** @description Details about the PaymentMethod for an InboundTransfer. */ + /** + * @nullable + * @description Details about the PaymentMethod for an InboundTransfer. + */ origin_payment_method_details?: components["schemas"]["inbound_transfers"] | null; - /** @description Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state. */ + /** + * @nullable + * @description Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state. + */ returned?: boolean | null; /** @description Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`. */ statement_descriptor: string; @@ -26776,7 +32089,10 @@ export interface components { */ status: "canceled" | "failed" | "processing" | "succeeded"; status_transitions: components["schemas"]["treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions"]; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -26793,33 +32109,51 @@ export interface components { /** @description Returns `true` if the object can be canceled, and `false` otherwise. */ cancelable: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. */ + /** + * @nullable + * @description ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. + */ customer?: string | null; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`. */ + /** + * @nullable + * @description The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`. + */ destination_payment_method?: string | null; - /** @description Details about the PaymentMethod for an OutboundPayment. */ + /** + * @nullable + * @description Details about the PaymentMethod for an OutboundPayment. + */ destination_payment_method_details?: components["schemas"]["outbound_payments_payment_method_details"] | null; - /** @description Details about the end user. */ + /** + * @nullable + * @description Details about the end user. + */ end_user_details?: components["schemas"]["treasury_outbound_payments_resource_outbound_payment_resource_end_user_details"] | null; /** - * Format: unix-time * @description The date when funds are expected to arrive in the destination account. + * @format unix-time */ expected_arrival_date: number; /** @description The FinancialAccount that funds were pulled from. */ financial_account: string; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26834,7 +32168,10 @@ export interface components { * @enum {string} */ object: "treasury.outbound_payment"; - /** @description Details about a returned OutboundPayment. Only set when the status is `returned`. */ + /** + * @nullable + * @description Details about a returned OutboundPayment. Only set when the status is `returned`. + */ returned_details?: components["schemas"]["treasury_outbound_payments_resource_returned_status"] | null; /** @description The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). */ statement_descriptor: string; @@ -26844,7 +32181,10 @@ export interface components { */ status: "canceled" | "failed" | "posted" | "processing" | "returned"; status_transitions: components["schemas"]["treasury_outbound_payments_resource_outbound_payment_resource_status_transitions"]; - /** @description Details about network-specific tracking information if available. */ + /** + * @nullable + * @description Details about network-specific tracking information if available. + */ tracking_details?: components["schemas"]["treasury_outbound_payments_resource_outbound_payment_resource_tracking_details"] | null; /** @description The Transaction associated with this object. */ transaction: string | components["schemas"]["treasury.transaction"]; @@ -26863,28 +32203,37 @@ export interface components { /** @description Returns `true` if the object can be canceled, and `false` otherwise. */ cancelable: boolean; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; - /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + /** + * @nullable + * @description An arbitrary string attached to the object. Often useful for displaying to users. + */ description?: string | null; - /** @description The PaymentMethod used as the payment instrument for an OutboundTransfer. */ + /** + * @nullable + * @description The PaymentMethod used as the payment instrument for an OutboundTransfer. + */ destination_payment_method?: string | null; destination_payment_method_details: components["schemas"]["outbound_transfers_payment_method_details"]; /** - * Format: unix-time * @description The date when funds are expected to arrive in the destination account. + * @format unix-time */ expected_arrival_date: number; /** @description The FinancialAccount that funds were pulled from. */ financial_account: string; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26899,7 +32248,10 @@ export interface components { * @enum {string} */ object: "treasury.outbound_transfer"; - /** @description Details about a returned OutboundTransfer. Only set when the status is `returned`. */ + /** + * @nullable + * @description Details about a returned OutboundTransfer. Only set when the status is `returned`. + */ returned_details?: components["schemas"]["treasury_outbound_transfers_resource_returned_details"] | null; /** @description Information about the OutboundTransfer to be sent to the recipient account. */ statement_descriptor: string; @@ -26909,7 +32261,10 @@ export interface components { */ status: "canceled" | "failed" | "posted" | "processing" | "returned"; status_transitions: components["schemas"]["treasury_outbound_transfers_resource_status_transitions"]; - /** @description Details about network-specific tracking information if available. */ + /** + * @nullable + * @description Details about network-specific tracking information if available. + */ tracking_details?: components["schemas"]["treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details"] | null; /** @description The Transaction associated with this object. */ transaction: string | components["schemas"]["treasury.transaction"]; @@ -26922,25 +32277,32 @@ export interface components { /** @description Amount (in cents) transferred. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; /** + * @nullable * @description Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. * @enum {string|null} */ failure_code?: "account_closed" | "account_frozen" | "international_transaction" | "other" | null; - /** @description The FinancialAccount that received the funds. */ + /** + * @nullable + * @description The FinancialAccount that received the funds. + */ financial_account?: string | null; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26958,14 +32320,20 @@ export interface components { * @enum {string} */ object: "treasury.received_credit"; - /** @description Details describing when a ReceivedCredit may be reversed. */ + /** + * @nullable + * @description Details describing when a ReceivedCredit may be reversed. + */ reversal_details?: components["schemas"]["treasury_received_credits_resource_reversal_details"] | null; /** * @description Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field. * @enum {string} */ status: "failed" | "succeeded"; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -26976,25 +32344,32 @@ export interface components { /** @description Amount (in cents) transferred. */ amount: number; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; /** + * @nullable * @description Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen. * @enum {string|null} */ failure_code?: "account_closed" | "account_frozen" | "insufficient_funds" | "international_transaction" | "other" | null; - /** @description The FinancialAccount that funds were pulled from. */ + /** + * @nullable + * @description The FinancialAccount that funds were pulled from. + */ financial_account?: string | null; - /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /** + * @nullable + * @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. + */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -27012,14 +32387,20 @@ export interface components { * @enum {string} */ object: "treasury.received_debit"; - /** @description Details describing when a ReceivedDebit might be reversed. */ + /** + * @nullable + * @description Details describing when a ReceivedDebit might be reversed. + */ reversal_details?: components["schemas"]["treasury_received_debits_resource_reversal_details"] | null; /** * @description Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`. * @enum {string} */ status: "failed" | "succeeded"; - /** @description The Transaction associated with this object. */ + /** + * @nullable + * @description The Transaction associated with this object. + */ transaction?: (string | components["schemas"]["treasury.transaction"]) | null; }; /** @@ -27031,19 +32412,20 @@ export interface components { amount: number; balance_impact: components["schemas"]["treasury_transactions_resource_balance_impact"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; /** * TreasuryTransactionsResourceTransactionEntryList + * @nullable * @description A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. */ entries?: { @@ -27056,14 +32438,23 @@ export interface components { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/treasury/transaction_entries + */ url: string; } | null; /** @description The FinancialAccount associated with this object. */ financial_account: string; - /** @description ID of the flow that created the Transaction. */ + /** + * @nullable + * @description ID of the flow that created the Transaction. + */ flow?: string | null; - /** @description Details of the flow that created the Transaction. */ + /** + * @nullable + * @description Details of the flow that created the Transaction. + */ flow_details?: components["schemas"]["treasury_transactions_resource_flow_details"] | null; /** * @description Type of the flow that created the Transaction. @@ -27093,25 +32484,31 @@ export interface components { "treasury.transaction_entry": { balance_impact: components["schemas"]["treasury_transactions_resource_balance_impact"]; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** - * Format: unix-time * @description When the TransactionEntry will impact the FinancialAccount's balance. + * @format unix-time */ effective_at: number; /** @description The FinancialAccount associated with this object. */ financial_account: string; - /** @description Token of the flow associated with the TransactionEntry. */ + /** + * @nullable + * @description Token of the flow associated with the TransactionEntry. + */ flow?: string | null; - /** @description Details of the flow associated with the TransactionEntry. */ + /** + * @nullable + * @description Details of the flow associated with the TransactionEntry. + */ flow_details?: components["schemas"]["treasury_transactions_resource_flow_details"] | null; /** * @description Type of the flow associated with the TransactionEntry. @@ -27142,7 +32539,10 @@ export interface components { treasury_financial_accounts_resource_aba_record: { /** @description The name of the person or business that owns the bank account. */ account_holder_name: string; - /** @description The account number. */ + /** + * @nullable + * @description The account number. + */ account_number?: string | null; /** @description The last four characters of the account number. */ account_number_last4: string; @@ -27269,11 +32669,13 @@ export interface components { */ treasury_financial_accounts_resource_platform_restrictions: { /** + * @nullable * @description Restricts all inbound money movement. * @enum {string|null} */ inbound_flows?: "restricted" | "unrestricted" | null; /** + * @nullable * @description Restricts all outbound money movement. * @enum {string|null} */ @@ -27281,7 +32683,10 @@ export interface components { }; /** TreasuryFinancialAccountsResourceStatusDetails */ treasury_financial_accounts_resource_status_details: { - /** @description Details related to the closure of this FinancialAccount */ + /** + * @nullable + * @description Details related to the closure of this FinancialAccount + */ closed?: components["schemas"]["treasury_financial_accounts_resource_closed_status_details"] | null; }; /** @@ -27310,6 +32715,7 @@ export interface components { */ code: "activating" | "capability_not_requested" | "financial_account_closed" | "rejected_other" | "rejected_unsupported_business" | "requirements_past_due" | "requirements_pending_verification" | "restricted_by_platform" | "restricted_other"; /** + * @nullable * @description Represents what the user should do, if anything, to activate the Feature. * @enum {string|null} */ @@ -27330,24 +32736,30 @@ export interface components { }; /** TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows */ treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows: { - /** @description If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return. */ + /** + * @nullable + * @description If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return. + */ received_debit?: string | null; }; /** TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions */ treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when an InboundTransfer changed status to `canceled`. + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an InboundTransfer changed status to `failed`. + * @format unix-time */ failed_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an InboundTransfer changed status to `succeeded`. + * @format unix-time */ succeeded_at?: number | null; }; @@ -27358,7 +32770,10 @@ export interface components { }; /** TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails */ treasury_outbound_payments_resource_outbound_payment_resource_end_user_details: { - /** @description IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked. */ + /** + * @nullable + * @description IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked. + */ ip_address?: string | null; /** @description `true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`. */ present: boolean; @@ -27366,23 +32781,27 @@ export interface components { /** TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions */ treasury_outbound_payments_resource_outbound_payment_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundPayment changed status to `canceled`. + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundPayment changed status to `failed`. + * @format unix-time */ failed_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundPayment changed status to `posted`. + * @format unix-time */ posted_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundPayment changed status to `returned`. + * @format unix-time */ returned_at?: number | null; }; @@ -27408,11 +32827,20 @@ export interface components { }; /** TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails */ treasury_outbound_payments_resource_us_domestic_wire_tracking_details: { - /** @description CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network. + */ chips?: string | null; - /** @description IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. + */ imad?: string | null; - /** @description OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. + */ omad?: string | null; }; /** TreasuryOutboundTransfersResourceACHTrackingDetails */ @@ -27443,58 +32871,91 @@ export interface components { /** TreasuryOutboundTransfersResourceStatusTransitions */ treasury_outbound_transfers_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundTransfer changed status to `canceled` + * @format unix-time */ canceled_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundTransfer changed status to `failed` + * @format unix-time */ failed_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundTransfer changed status to `posted` + * @format unix-time */ posted_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when an OutboundTransfer changed status to `returned` + * @format unix-time */ returned_at?: number | null; }; /** TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails */ treasury_outbound_transfers_resource_us_domestic_wire_tracking_details: { - /** @description CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. + */ chips?: string | null; - /** @description IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. + */ imad?: string | null; - /** @description OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + /** + * @nullable + * @description OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. + */ omad?: string | null; }; /** TreasuryReceivedCreditsResourceLinkedFlows */ treasury_received_credits_resource_linked_flows: { - /** @description The CreditReversal created as a result of this ReceivedCredit being reversed. */ + /** + * @nullable + * @description The CreditReversal created as a result of this ReceivedCredit being reversed. + */ credit_reversal?: string | null; - /** @description Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. */ + /** + * @nullable + * @description Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. + */ issuing_authorization?: string | null; - /** @description Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object. */ + /** + * @nullable + * @description Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object. + */ issuing_transaction?: string | null; - /** @description ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. */ + /** + * @nullable + * @description ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. + */ source_flow?: string | null; - /** @description The expandable object of the source flow. */ + /** + * @nullable + * @description The expandable object of the source flow. + */ source_flow_details?: components["schemas"]["treasury_received_credits_resource_source_flows_details"] | null; - /** @description The type of flow that originated the ReceivedCredit (for example, `outbound_payment`). */ + /** + * @nullable + * @description The type of flow that originated the ReceivedCredit (for example, `outbound_payment`). + */ source_flow_type?: string | null; }; /** TreasuryReceivedCreditsResourceReversalDetails */ treasury_received_credits_resource_reversal_details: { /** - * Format: unix-time + * @nullable * @description Time before which a ReceivedCredit can be reversed. + * @format unix-time */ deadline?: number | null; /** + * @nullable * @description Set if a ReceivedCredit cannot be reversed. * @enum {string|null} */ @@ -27515,37 +32976,58 @@ export interface components { /** TreasuryReceivedCreditsResourceStatusTransitions */ treasury_received_credits_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when the CreditReversal changed status to `posted` + * @format unix-time */ posted_at?: number | null; }; /** TreasuryReceivedDebitsResourceDebitReversalLinkedFlows */ treasury_received_debits_resource_debit_reversal_linked_flows: { - /** @description Set if there is an Issuing dispute associated with the DebitReversal. */ + /** + * @nullable + * @description Set if there is an Issuing dispute associated with the DebitReversal. + */ issuing_dispute?: string | null; }; /** TreasuryReceivedDebitsResourceLinkedFlows */ treasury_received_debits_resource_linked_flows: { - /** @description The DebitReversal created as a result of this ReceivedDebit being reversed. */ + /** + * @nullable + * @description The DebitReversal created as a result of this ReceivedDebit being reversed. + */ debit_reversal?: string | null; - /** @description Set if the ReceivedDebit is associated with an InboundTransfer's return of funds. */ + /** + * @nullable + * @description Set if the ReceivedDebit is associated with an InboundTransfer's return of funds. + */ inbound_transfer?: string | null; - /** @description Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. */ + /** + * @nullable + * @description Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. + */ issuing_authorization?: string | null; - /** @description Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object. */ + /** + * @nullable + * @description Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object. + */ issuing_transaction?: string | null; - /** @description Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object. */ + /** + * @nullable + * @description Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object. + */ payout?: string | null; }; /** TreasuryReceivedDebitsResourceReversalDetails */ treasury_received_debits_resource_reversal_details: { /** - * Format: unix-time + * @nullable * @description Time before which a ReceivedDebit can be reversed. + * @format unix-time */ deadline?: number | null; /** + * @nullable * @description Set if a ReceivedDebit can't be reversed. * @enum {string|null} */ @@ -27554,17 +33036,24 @@ export interface components { /** TreasuryReceivedDebitsResourceStatusTransitions */ treasury_received_debits_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when the DebitReversal changed status to `completed`. + * @format unix-time */ completed_at?: number | null; }; /** TreasurySharedResourceBillingDetails */ treasury_shared_resource_billing_details: { address: components["schemas"]["address"]; - /** @description Email address. */ + /** + * @nullable + * @description Email address. + */ email?: string | null; - /** @description Full name. */ + /** + * @nullable + * @description Full name. + */ name?: string | null; }; /** TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails */ @@ -27587,23 +33076,34 @@ export interface components { }; /** TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount */ treasury_shared_resource_initiating_payment_method_details_us_bank_account: { - /** @description Bank name. */ + /** + * @nullable + * @description Bank name. + */ bank_name?: string | null; - /** @description The last four digits of the bank account number. */ + /** + * @nullable + * @description The last four digits of the bank account number. + */ last4?: string | null; - /** @description The routing number for the bank account. */ + /** + * @nullable + * @description The routing number for the bank account. + */ routing_number?: string | null; }; /** TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions */ treasury_transactions_resource_abstract_transaction_resource_status_transitions: { /** - * Format: unix-time + * @nullable * @description Timestamp describing when the Transaction changed status to `posted`. + * @format unix-time */ posted_at?: number | null; /** - * Format: unix-time + * @nullable * @description Timestamp describing when the Transaction changed status to `void`. + * @format unix-time */ void_at?: number | null; }; @@ -27637,7 +33137,10 @@ export interface components { }; /** us_bank_account_networks */ us_bank_account_networks: { - /** @description The preferred network. */ + /** + * @nullable + * @description The preferred network. + */ preferred?: string | null; /** @description All supported networks. */ supported: ("ach" | "us_domestic_wire")[]; @@ -27666,8 +33169,8 @@ export interface components { /** @description The ID of the subscription item this usage record contains data for. */ subscription_item: string; /** - * Format: unix-time * @description The timestamp when this usage occurred. + * @format unix-time */ timestamp: number; }; @@ -27678,7 +33181,10 @@ export interface components { usage_record_summary: { /** @description Unique identifier for the object. */ id: string; - /** @description The invoice in which this usage period has been billed for. */ + /** + * @nullable + * @description The invoice in which this usage period has been billed for. + */ invoice?: string | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -27712,16 +33218,25 @@ export interface components { * Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure) */ webhook_endpoint: { - /** @description The API version events are rendered as for this webhook endpoint. */ + /** + * @nullable + * @description The API version events are rendered as for this webhook endpoint. + */ api_version?: string | null; - /** @description The ID of the associated Connect application. */ + /** + * @nullable + * @description The ID of the associated Connect application. + */ application?: string | null; /** - * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. + * @format unix-time */ created: number; - /** @description An optional description of what the webhook is used for. */ + /** + * @nullable + * @description An optional description of what the webhook is used for. + */ description?: string | null; /** @description The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ enabled_events: string[]; @@ -28079,7 +33594,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/accounts + */ url: string; }; }; @@ -28116,7 +33634,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -28137,7 +33655,7 @@ export interface operations { /** annual_revenue_specs */ annual_revenue?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; fiscal_year_end: string; }; @@ -28146,7 +33664,7 @@ export interface operations { /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; }; name?: string; @@ -28436,7 +33954,7 @@ export interface operations { directors_provided?: boolean; /** company_directorship_declaration */ directorship_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -28450,7 +33968,7 @@ export interface operations { owners_provided?: boolean; /** company_ownership_declaration */ ownership_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -28499,8 +34017,8 @@ export interface operations { /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported. */ country?: string; /** - * Format: currency * @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + * @format currency */ default_currency?: string; /** @@ -28667,7 +34185,7 @@ export interface operations { card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -28708,7 +34226,7 @@ export interface operations { treasury?: { /** settings_terms_of_service_specs */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -28720,7 +34238,7 @@ export interface operations { * @description Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty. */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; service_agreement?: string; @@ -28815,7 +34333,7 @@ export interface operations { /** annual_revenue_specs */ annual_revenue?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; fiscal_year_end: string; }; @@ -28824,7 +34342,7 @@ export interface operations { /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; }; name?: string; @@ -29114,7 +34632,7 @@ export interface operations { directors_provided?: boolean; /** company_directorship_declaration */ directorship_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -29128,7 +34646,7 @@ export interface operations { owners_provided?: boolean; /** company_ownership_declaration */ ownership_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -29152,8 +34670,8 @@ export interface operations { }; }; /** - * Format: currency * @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + * @format currency */ default_currency?: string; /** @@ -29320,7 +34838,7 @@ export interface operations { card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -29365,7 +34883,7 @@ export interface operations { treasury?: { /** settings_terms_of_service_specs */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -29377,7 +34895,7 @@ export interface operations { * @description Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty. */ tos_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; service_agreement?: string; @@ -29463,7 +34981,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -29882,7 +35400,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -30210,7 +35728,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -30443,7 +35961,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -30736,7 +36254,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -30969,7 +36487,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -31257,7 +36775,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/apple_pay/domains + */ url: string; }; }; @@ -31429,7 +36950,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/application_fees + */ url: string; }; }; @@ -31748,7 +37272,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/apps/secrets + */ url: string; }; }; @@ -31777,8 +37304,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The Unix timestamp for the expiry time of the secret, after which the secret deletes. + * @format unix-time */ expires_at?: number; /** @description A name for the secret that's unique within the scope. */ @@ -31997,7 +37524,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/balance_transactions + */ url: string; }; }; @@ -32103,7 +37633,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/balance_transactions + */ url: string; }; }; @@ -32198,7 +37731,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/alerts + */ url: string; }; }; @@ -32514,7 +38050,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/credit_grants + */ url: string; }; }; @@ -32608,7 +38147,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/credit_grants + */ url: string; }; }; @@ -32641,7 +38183,7 @@ export interface operations { amount: { /** monetary_amount_param */ monetary?: { - /** Format: currency */ + /** @format currency */ currency: string; value: number; }; @@ -32667,15 +38209,15 @@ export interface operations { /** @description ID of the customer to receive the billing credits. */ customer: string; /** - * Format: unix-time * @description The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified. + * @format unix-time */ effective_at?: number; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The time when the billing credits expire. If not specified, the billing credits don't expire. + * @format unix-time */ expires_at?: number; /** @description Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format. */ @@ -32941,8 +38483,8 @@ export interface operations { [key: string]: string; }; /** - * Format: unix-time * @description The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified. + * @format unix-time */ timestamp?: number; }; @@ -33008,7 +38550,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/meters + */ url: string; }; }; @@ -33260,7 +38805,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing/meters/[^/]+/event_summaries + */ url: string; }; }; @@ -33356,7 +38904,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/billing_portal/configurations + */ url: string; }; }; @@ -33780,7 +39331,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/charges + */ url: string; }; }; @@ -33833,8 +39387,8 @@ export interface operations { object?: "card"; } | string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description The ID of an existing customer that will be charged in this request. */ @@ -33956,6 +39510,7 @@ export interface operations { "application/json": { data: components["schemas"]["charge"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -34486,8 +40041,8 @@ export interface operations { "application/x-www-form-urlencoded": { amount?: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Customer whose customer balance to refund from. */ @@ -34767,8 +40322,8 @@ export interface operations { terms_of_service?: "none" | "required"; }; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. + * @format currency */ currency?: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ @@ -34877,8 +40432,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. + * @format unix-time */ expires_at?: number; /** @@ -34929,7 +40484,7 @@ export interface operations { price?: string; /** price_data_with_product_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product?: string; /** product_data */ @@ -34951,7 +40506,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -35390,7 +40945,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -35423,7 +40978,7 @@ export interface operations { */ subscription_data?: { application_fee_percent?: number; - /** Format: unix-time */ + /** @format unix-time */ billing_cycle_anchor?: number; default_tax_rates?: string[]; description?: string; @@ -35447,7 +41002,7 @@ export interface operations { amount_percent?: number; destination: string; }; - /** Format: unix-time */ + /** @format unix-time */ trial_end?: number; trial_period_days?: number; /** trial_settings_config */ @@ -35716,7 +41271,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/climate/orders + */ url: string; }; }; @@ -35760,8 +41318,8 @@ export interface operations { [key: string]: string; }; /** - * Format: decimal * @description Requested number of tons for the order. Either this or `amount` must be specified. + * @format decimal */ metric_tons?: string; /** @description Unique identifier of the Climate product. */ @@ -35952,7 +41510,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/climate/products + */ url: string; }; }; @@ -36043,7 +41604,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/climate/suppliers + */ url: string; }; }; @@ -36172,7 +41736,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/country_specs + */ url: string; }; }; @@ -36270,7 +41837,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/coupons + */ url: string; }; }; @@ -36306,8 +41876,8 @@ export interface operations { products?: string[]; }; /** - * Format: currency * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). + * @format currency */ currency?: string; /** @description Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ @@ -36338,8 +41908,8 @@ export interface operations { /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). */ percent_off?: number; /** - * Format: unix-time * @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. + * @format unix-time */ redeem_by?: number; }; @@ -36568,8 +42138,8 @@ export interface operations { /** @description The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ credit_amount?: number; /** - * Format: unix-time * @description The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. + * @format unix-time */ effective_at?: number; /** @@ -36596,7 +42166,7 @@ export interface operations { /** @enum {string} */ type: "custom_line_item" | "invoice_line_item"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The credit note's memo appears on the credit note PDF. */ @@ -36677,7 +42247,7 @@ export interface operations { /** @enum {string} */ type: "custom_line_item" | "invoice_line_item"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The credit note's memo appears on the credit note PDF. */ @@ -36763,7 +42333,7 @@ export interface operations { /** @enum {string} */ type: "custom_line_item" | "invoice_line_item"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The credit note's memo appears on the credit note PDF. */ @@ -37122,7 +42692,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/customers + */ url: string; }; }; @@ -37303,6 +42876,7 @@ export interface operations { "application/json": { data: components["schemas"]["customer"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -37394,7 +42968,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -37643,8 +43217,8 @@ export interface operations { /** @description The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -37840,7 +43414,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -38175,7 +43749,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -38671,8 +44245,8 @@ export interface operations { type: "eu_bank_transfer" | "gb_bank_transfer" | "jp_bank_transfer" | "mx_bank_transfer" | "us_bank_transfer"; }; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Specifies which fields in the response should be expanded. */ @@ -38883,7 +44457,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -39220,13 +44794,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -39248,13 +44822,13 @@ export interface operations { }; }; /** - * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. + * @format unix-time */ backdate_start_date?: number; /** - * Format: unix-time * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. + * @format unix-time */ billing_cycle_anchor?: number; /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ @@ -39263,8 +44837,8 @@ export interface operations { reset_billing_cycle_anchor?: boolean; } | ""; /** - * Format: unix-time * @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. + * @format unix-time */ cancel_at?: number; /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ @@ -39277,8 +44851,8 @@ export interface operations { /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ @@ -39326,7 +44900,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -39338,7 +44912,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -39553,13 +45127,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -39658,7 +45232,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -39670,7 +45244,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -39686,7 +45260,7 @@ export interface operations { pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; - /** Format: unix-time */ + /** @format unix-time */ resumes_at?: number; } | ""; /** @@ -39778,8 +45352,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + * @format unix-time */ proration_date?: number; /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ @@ -40168,7 +45742,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/disputes + */ url: string; }; }; @@ -40519,7 +46096,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/entitlements/features + */ url: string; }; }; @@ -40796,7 +46376,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/events + */ url: string; }; }; @@ -40887,7 +46470,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/exchange_rates + */ url: string; }; }; @@ -40990,7 +46576,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/file_links + */ url: string; }; }; @@ -41019,8 +46608,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The link isn't usable after this future timestamp. + * @format unix-time */ expires_at?: number; /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. */ @@ -41181,7 +46770,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/files + */ url: string; }; }; @@ -41210,8 +46802,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: binary * @description A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol. + * @format binary */ file: string; /** @@ -41220,7 +46812,7 @@ export interface operations { */ file_link_data?: { create: boolean; - /** Format: unix-time */ + /** @format unix-time */ expires_at?: number; metadata?: { [key: string]: string; @@ -41338,7 +46930,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/financial_connections/accounts + */ url: string; }; }; @@ -41761,7 +47356,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/financial_connections/transactions + */ url: string; }; }; @@ -42020,7 +47618,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/identity/verification_reports + */ url: string; }; }; @@ -42123,7 +47724,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/identity/verification_sessions + */ url: string; }; }; @@ -42613,7 +48217,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/invoiceitems + */ url: string; }; }; @@ -42642,8 +48249,8 @@ export interface operations { /** @description The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ amount?: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description The ID of the customer who will be billed when this invoice item is billed. */ @@ -42671,9 +48278,9 @@ export interface operations { * @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 */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; /** @description The ID of the price object. One of `price` or `price_data` is required. */ @@ -42683,13 +48290,13 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @description Non-negative integer. The quantity of units for the invoice item. */ @@ -42708,8 +48315,8 @@ export interface operations { /** @description The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ unit_amount?: number; /** - * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + * @format decimal */ unit_amount_decimal?: string; }; @@ -42809,9 +48416,9 @@ export interface operations { * @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 */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; /** @description The ID of the price object. One of `price` or `price_data` is required. */ @@ -42821,13 +48428,13 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @description Non-negative integer. The quantity of units for the invoice item. */ @@ -42844,8 +48451,8 @@ export interface operations { /** @description The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ unit_amount?: number; /** - * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + * @format decimal */ unit_amount_decimal?: string; }; @@ -42965,7 +48572,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/invoices + */ url: string; }; }; @@ -43011,8 +48621,8 @@ export interface operations { }; }; /** - * Format: unix-time * @description The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. + * @format unix-time */ automatically_finalizes_at?: number; /** @@ -43021,8 +48631,8 @@ export interface operations { */ collection_method?: "charge_automatically" | "send_invoice"; /** - * Format: currency * @description The currency to create this invoice in. Defaults to that of `customer` if not specified. + * @format currency */ currency?: string; /** @description A list of up to 4 custom fields to be displayed on the invoice. */ @@ -43049,13 +48659,13 @@ export interface operations { promotion_code?: string; }[] | ""; /** - * Format: unix-time * @description The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. + * @format unix-time */ due_date?: number; /** - * Format: unix-time * @description The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. + * @format unix-time */ effective_at?: number; /** @description Specifies which fields in the response should be expanded. */ @@ -43200,7 +48810,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -43299,8 +48909,8 @@ export interface operations { /** @description The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; /** - * Format: currency * @description The currency to preview this invoice in. Defaults to that of `customer` if not specified. + * @format currency */ currency?: string; /** @description The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ @@ -43354,7 +48964,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; discountable?: boolean; @@ -43369,21 +48979,21 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43392,7 +49002,7 @@ export interface operations { tax_code?: string | ""; tax_rates?: string[] | ""; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @@ -43430,13 +49040,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43497,7 +49107,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43509,7 +49119,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43564,7 +49174,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43576,7 +49186,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43584,11 +49194,11 @@ export interface operations { }[]; /** @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** Format: unix-time */ + /** @format unix-time */ proration_date?: number; /** @enum {string} */ resume_at?: "now"; - /** Format: unix-time */ + /** @format unix-time */ start_date?: number; trial_end?: "now" | number; }; @@ -43647,6 +49257,7 @@ export interface operations { "application/json": { data: components["schemas"]["invoice"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -43735,7 +49346,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; discountable?: boolean; @@ -43750,21 +49361,21 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43773,7 +49384,7 @@ export interface operations { tax_code?: string | ""; tax_rates?: string[] | ""; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ @@ -43802,13 +49413,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43869,7 +49480,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43881,7 +49492,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43943,7 +49554,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43955,7 +49566,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -43963,11 +49574,11 @@ export interface operations { }[]; /** @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** Format: unix-time */ + /** @format unix-time */ proration_date?: number; /** @enum {string} */ resume_at?: "now"; - /** Format: unix-time */ + /** @format unix-time */ start_date?: number; trial_end?: "now" | number; }; @@ -43990,7 +49601,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -44002,7 +49613,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44116,7 +49727,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; discountable?: boolean; @@ -44131,21 +49742,21 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44154,7 +49765,7 @@ export interface operations { tax_code?: string | ""; tax_rates?: string[] | ""; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }[]; /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ @@ -44185,13 +49796,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44252,7 +49863,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -44264,7 +49875,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44328,7 +49939,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -44340,7 +49951,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44348,11 +49959,11 @@ export interface operations { }[]; /** @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** Format: unix-time */ + /** @format unix-time */ proration_date?: number; /** @enum {string} */ resume_at?: "now"; - /** Format: unix-time */ + /** @format unix-time */ start_date?: number; trial_end?: "now" | number; }; @@ -44375,7 +49986,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -44387,7 +49998,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -44516,8 +50127,8 @@ export interface operations { }; }; /** - * Format: unix-time * @description The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. To turn off automatic finalization, set `auto_advance` to false. + * @format unix-time */ automatically_finalizes_at?: number; /** @@ -44547,8 +50158,8 @@ export interface operations { promotion_code?: string; }[] | ""; /** - * Format: unix-time * @description The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. + * @format unix-time */ due_date?: number; /** @description The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. */ @@ -44678,7 +50289,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -44812,15 +50423,15 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data_with_product_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product?: string; /** product_data */ @@ -44836,7 +50447,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -45016,9 +50627,9 @@ export interface operations { * @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 */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; /** @description The ID of the price object. One of `price` or `price_data` is required. */ @@ -45028,7 +50639,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product?: string; /** product_data */ @@ -45044,7 +50655,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @description Non-negative integer. The quantity of units for the line item. */ @@ -45304,15 +50915,15 @@ export interface operations { } | ""; /** period */ period?: { - /** Format: unix-time */ + /** @format unix-time */ end: number; - /** Format: unix-time */ + /** @format unix-time */ start: number; }; price?: string; /** one_time_price_data_with_product_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product?: string; /** product_data */ @@ -45328,7 +50939,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -45462,7 +51073,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/authorizations + */ url: string; }; }; @@ -45696,7 +51310,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/cardholders + */ url: string; }; }; @@ -45757,7 +51374,7 @@ export interface operations { card_issuing?: { /** terms_acceptance_param */ user_terms_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -45929,7 +51546,7 @@ export interface operations { card_issuing?: { /** terms_acceptance_param */ user_terms_acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -46066,7 +51683,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/cards + */ url: string; }; }; @@ -46395,7 +52015,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/disputes + */ url: string; }; }; @@ -46770,7 +52393,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/personalization_designs + */ url: string; }; }; @@ -46998,7 +52624,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/physical_bundles + */ url: string; }; }; @@ -47327,7 +52956,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/issuing/transactions + */ url: string; }; }; @@ -47570,7 +53202,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/financial_connections/accounts + */ url: string; }; }; @@ -47844,7 +53479,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_intents + */ url: string; }; }; @@ -47902,8 +53540,8 @@ export interface operations { */ confirmation_token?: string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @@ -47926,7 +53564,7 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - /** Format: unix-time */ + /** @format unix-time */ accepted_at?: number; /** offline_param */ offline?: Record; @@ -48220,13 +53858,13 @@ export interface operations { /** @enum {string} */ amount_type: "fixed" | "maximum"; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -48403,7 +54041,7 @@ export interface operations { } | ""; pix?: { expires_after_seconds?: number; - /** Format: unix-time */ + /** @format unix-time */ expires_at?: number; /** @enum {string} */ setup_future_usage?: "none"; @@ -48603,6 +54241,7 @@ export interface operations { "application/json": { data: components["schemas"]["payment_intent"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -48688,8 +54327,8 @@ export interface operations { */ capture_method?: "automatic" | "automatic_async" | "manual"; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @@ -48977,13 +54616,13 @@ export interface operations { /** @enum {string} */ amount_type: "fixed" | "maximum"; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -49160,7 +54799,7 @@ export interface operations { } | ""; pix?: { expires_after_seconds?: number; - /** Format: unix-time */ + /** @format unix-time */ expires_at?: number; /** @enum {string} */ setup_future_usage?: "none"; @@ -49336,8 +54975,8 @@ export interface operations { */ amount?: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -49507,7 +55146,7 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - /** Format: unix-time */ + /** @format unix-time */ accepted_at?: number; /** offline_param */ offline?: Record; @@ -49800,13 +55439,13 @@ export interface operations { /** @enum {string} */ amount_type: "fixed" | "maximum"; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -49983,7 +55622,7 @@ export interface operations { } | ""; pix?: { expires_after_seconds?: number; - /** Format: unix-time */ + /** @format unix-time */ expires_at?: number; /** @enum {string} */ setup_future_usage?: "none"; @@ -50277,7 +55916,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_links + */ url: string; }; }; @@ -50359,8 +56001,8 @@ export interface operations { terms_of_service?: "none" | "required"; }; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. + * @format currency */ currency?: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ @@ -50992,7 +56634,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_method_configurations + */ url: string; }; }; @@ -52115,7 +57760,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_method_domains + */ url: string; }; }; @@ -52328,7 +57976,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payment_methods + */ url: string; }; }; @@ -52979,7 +58630,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/payouts + */ url: string; }; }; @@ -53008,8 +58662,8 @@ export interface operations { /** @description A positive integer in cents representing how much to payout. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -53267,7 +58921,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/plans + */ url: string; }; }; @@ -53303,8 +58960,8 @@ export interface operations { /** @description A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis. */ amount?: number; /** - * Format: decimal * @description Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. + * @format decimal */ amount_decimal?: string; /** @@ -53313,8 +58970,8 @@ export interface operations { */ billing_scheme?: "per_unit" | "tiered"; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Specifies which fields in the response should be expanded. */ @@ -53351,10 +59008,10 @@ export interface operations { /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; @@ -53589,7 +59246,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/prices + */ url: string; }; }; @@ -53623,8 +59283,8 @@ export interface operations { */ billing_scheme?: "per_unit" | "tiered"; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ @@ -53641,15 +59301,15 @@ export interface operations { tax_behavior?: "exclusive" | "inclusive" | "unspecified"; tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; }; @@ -53713,10 +59373,10 @@ export interface operations { /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; @@ -53739,8 +59399,8 @@ export interface operations { /** @description A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`. */ unit_amount?: number; /** - * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + * @format decimal */ unit_amount_decimal?: string; }; @@ -53798,6 +59458,7 @@ export interface operations { "application/json": { data: components["schemas"]["price"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -53887,15 +59548,15 @@ export interface operations { tax_behavior?: "exclusive" | "inclusive" | "unspecified"; tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; } | ""; @@ -53993,7 +59654,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/products + */ url: string; }; }; @@ -54026,7 +59690,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product. */ default_price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -54041,15 +59705,15 @@ export interface operations { tax_behavior?: "exclusive" | "inclusive" | "unspecified"; tiers?: { flat_amount?: number; - /** Format: decimal */ + /** @format decimal */ flat_amount_decimal?: string; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; up_to: "inf" | number; }[]; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; }; @@ -54069,7 +59733,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ @@ -54170,6 +59834,7 @@ export interface operations { "application/json": { data: components["schemas"]["product"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -54568,7 +60233,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/promotion_codes + */ url: string; }; }; @@ -54609,8 +60277,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`. + * @format unix-time */ expires_at?: number; /** @description A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`. */ @@ -54631,7 +60299,7 @@ export interface operations { }; first_time_transaction?: boolean; minimum_amount?: number; - /** Format: currency */ + /** @format currency */ minimum_amount_currency?: string; }; }; @@ -54794,7 +60462,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/quotes + */ url: string; }; }; @@ -54857,8 +60528,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. + * @format unix-time */ expires_at?: number; /** @description A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ @@ -54896,7 +60567,7 @@ export interface operations { price?: string; /** price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -54908,7 +60579,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -55051,8 +60722,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. + * @format unix-time */ expires_at?: number; /** @description A footer that will be displayed on the quote PDF. */ @@ -55083,7 +60754,7 @@ export interface operations { price?: string; /** price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -55095,7 +60766,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -55296,8 +60967,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. + * @format unix-time */ expires_at?: number; }; @@ -55466,7 +61137,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/radar/early_fraud_warnings + */ url: string; }; }; @@ -55568,7 +61242,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/radar/value_list_items + */ url: string; }; }; @@ -55745,7 +61422,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/radar/value_lists + */ url: string; }; }; @@ -55977,7 +61657,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/refunds + */ url: string; }; }; @@ -56007,8 +61690,8 @@ export interface operations { /** @description The identifier of the charge to refund. */ charge?: string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Customer whose customer balance to refund from. */ @@ -56223,7 +61906,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/reporting/report_runs + */ url: string; }; }; @@ -56258,11 +61944,11 @@ export interface operations { parameters?: { columns?: string[]; connected_account?: string; - /** Format: currency */ + /** @format currency */ currency?: string; - /** Format: unix-time */ + /** @format unix-time */ interval_end?: number; - /** Format: unix-time */ + /** @format unix-time */ interval_start?: number; payout?: string; /** @enum {string} */ @@ -56608,7 +62294,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/setup_attempts + */ url: string; }; }; @@ -56678,7 +62367,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/setup_intents + */ url: string; }; }; @@ -56747,7 +62439,7 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - /** Format: unix-time */ + /** @format unix-time */ accepted_at?: number; /** offline_param */ offline?: Record; @@ -56975,16 +62667,16 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; - /** Format: currency */ + /** @format currency */ currency: string; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -57065,7 +62757,7 @@ export interface operations { */ single_use?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; }; /** @@ -57386,16 +63078,16 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; - /** Format: currency */ + /** @format currency */ currency: string; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -57560,7 +63252,7 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - /** Format: unix-time */ + /** @format unix-time */ accepted_at?: number; /** offline_param */ offline?: Record; @@ -57791,16 +63483,16 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; - /** Format: currency */ + /** @format currency */ currency: string; description?: string; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** @enum {string} */ interval: "day" | "month" | "sporadic" | "week" | "year"; interval_count?: number; reference: string; - /** Format: unix-time */ + /** @format unix-time */ start_date: number; supported_types?: "india"[]; }; @@ -57995,7 +63687,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/shipping_rates + */ url: string; }; }; @@ -58049,7 +63744,7 @@ export interface operations { */ fixed_amount?: { amount: number; - /** Format: currency */ + /** @format currency */ currency: string; currency_options?: { [key: string]: { @@ -58236,7 +63931,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/sigma/scheduled_query_runs + */ url: string; }; }; @@ -58303,8 +64001,8 @@ export interface operations { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ amount?: number; /** - * Format: currency * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. + * @format currency */ currency?: string; /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ @@ -58323,7 +64021,7 @@ export interface operations { mandate?: { /** mandate_acceptance_params */ acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; /** mandate_offline_acceptance_params */ @@ -58332,7 +64030,7 @@ export interface operations { }; /** mandate_online_acceptance_params */ online?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -58344,7 +64042,7 @@ export interface operations { user_agent?: string; }; amount?: number | ""; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ interval?: "one_time" | "scheduled" | "variable"; @@ -58396,7 +64094,7 @@ export interface operations { source_order?: { items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; parent?: string; @@ -58516,7 +64214,7 @@ export interface operations { mandate?: { /** mandate_acceptance_params */ acceptance?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; /** mandate_offline_acceptance_params */ @@ -58525,7 +64223,7 @@ export interface operations { }; /** mandate_online_acceptance_params */ online?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -58537,7 +64235,7 @@ export interface operations { user_agent?: string; }; amount?: number | ""; - /** Format: currency */ + /** @format currency */ currency?: string; /** @enum {string} */ interval?: "one_time" | "scheduled" | "variable"; @@ -58573,7 +64271,7 @@ export interface operations { source_order?: { items?: { amount?: number; - /** Format: currency */ + /** @format currency */ currency?: string; description?: string; parent?: string; @@ -58834,7 +64532,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/subscription_items + */ url: string; }; }; @@ -58894,7 +64595,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -58906,7 +64607,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @@ -58915,8 +64616,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @format unix-time */ proration_date?: number; /** @description The quantity you'd like to apply to the subscription item you're creating. */ @@ -59035,7 +64736,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59047,7 +64748,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; /** @@ -59056,8 +64757,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @format unix-time */ proration_date?: number; /** @description The quantity you'd like to apply to the subscription item you're creating. */ @@ -59108,8 +64809,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @format unix-time */ proration_date?: number; }; @@ -59307,7 +65008,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/subscription_schedules + */ url: string; }; }; @@ -59402,13 +65106,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59434,7 +65138,7 @@ export interface operations { /** @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; coupon?: string; - /** Format: currency */ + /** @format currency */ currency?: string; default_payment_method?: string; default_tax_rates?: string[] | ""; @@ -59444,7 +65148,7 @@ export interface operations { discount?: string; promotion_code?: string; }[] | ""; - /** Format: unix-time */ + /** @format unix-time */ end_date?: number; /** invoice_settings */ invoice_settings?: { @@ -59472,7 +65176,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59484,7 +65188,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59503,7 +65207,7 @@ export interface operations { destination: string; }; trial?: boolean; - /** Format: unix-time */ + /** @format unix-time */ trial_end?: number; }[]; /** @description When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. */ @@ -59647,13 +65351,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59714,7 +65418,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59726,7 +65430,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59931,7 +65635,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/subscriptions + */ url: string; }; }; @@ -59967,13 +65674,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -59995,13 +65702,13 @@ export interface operations { }; }; /** - * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. + * @format unix-time */ backdate_start_date?: number; /** - * Format: unix-time * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. + * @format unix-time */ billing_cycle_anchor?: number; /** @@ -60021,8 +65728,8 @@ export interface operations { reset_billing_cycle_anchor?: boolean; } | ""; /** - * Format: unix-time * @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. + * @format unix-time */ cancel_at?: number; /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ @@ -60035,8 +65742,8 @@ export interface operations { /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description The identifier of the customer to subscribe. */ @@ -60088,7 +65795,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -60100,7 +65807,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -60286,6 +65993,7 @@ export interface operations { "application/json": { data: components["schemas"]["subscription"][]; has_more: boolean; + /** @nullable */ next_page?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -60369,13 +66077,13 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -60476,7 +66184,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { - /** Format: currency */ + /** @format currency */ currency: string; product: string; /** recurring_adhoc */ @@ -60488,7 +66196,7 @@ export interface operations { /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; unit_amount?: number; - /** Format: decimal */ + /** @format decimal */ unit_amount_decimal?: string; }; quantity?: number; @@ -60506,7 +66214,7 @@ export interface operations { pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; - /** Format: unix-time */ + /** @format unix-time */ resumes_at?: number; } | ""; /** @@ -60598,8 +66306,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + * @format unix-time */ proration_date?: number; /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ @@ -60757,8 +66465,8 @@ export interface operations { */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** - * Format: unix-time * @description If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @format unix-time */ proration_date?: number; }; @@ -60796,8 +66504,8 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`. */ @@ -60969,7 +66677,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/calculations/[^/]+/line_items + */ url: string; }; }; @@ -61024,7 +66735,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/registrations + */ url: string; }; }; @@ -61649,8 +67363,8 @@ export interface operations { /** @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. + * @format unix-time */ expires_at?: number; }; @@ -61872,8 +67586,8 @@ export interface operations { [key: string]: string; }; /** - * Format: unix-time * @description The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time. + * @format unix-time */ posted_at?: number; /** @description A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals. */ @@ -62050,7 +67764,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax/transactions/[^/]+/line_items + */ url: string; }; }; @@ -62392,7 +68109,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/tax_rates + */ url: string; }; }; @@ -62605,7 +68325,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/terminal/configurations + */ url: string; }; }; @@ -63099,7 +68822,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/terminal/locations + */ url: string; }; }; @@ -63747,7 +69473,7 @@ export interface operations { * @description Cart */ cart?: { - /** Format: currency */ + /** @format currency */ currency: string; line_items: { amount: number; @@ -64033,8 +69759,8 @@ export interface operations { /** @description Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Specifies which fields in the response should be expanded. */ @@ -64093,8 +69819,8 @@ export interface operations { /** @description Card associated with this authorization. */ card: string; /** - * Format: currency * @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -64118,19 +69844,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -64143,13 +69869,13 @@ export interface operations { */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ @@ -64157,8 +69883,8 @@ export interface operations { /** @description The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ merchant_amount?: number; /** - * Format: currency * @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ merchant_currency?: string; /** @@ -64278,19 +70004,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -64299,7 +70025,7 @@ export interface operations { }; /** flight_specs */ flight?: { - /** Format: unix-time */ + /** @format unix-time */ departure_at?: number; passenger_name?: string; refundable?: boolean; @@ -64316,24 +70042,24 @@ export interface operations { /** fuel_specs */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; /** lodging_specs */ lodging?: { - /** Format: unix-time */ + /** @format unix-time */ check_in_at?: number; nights?: number; }; receipt?: { description?: string; - /** Format: decimal */ + /** @format decimal */ quantity?: string; total?: number; unit_cost?: number; @@ -64437,19 +70163,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -64462,13 +70188,13 @@ export interface operations { */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; }; @@ -64944,8 +70670,8 @@ export interface operations { /** @description The date that the transactions are cleared and posted to user's accounts. */ clearing_date: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description Specifies which fields in the response should be expanded. */ @@ -64999,8 +70725,8 @@ export interface operations { /** @description Card associated with this transaction. */ card: string; /** - * Format: currency * @description The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -65042,19 +70768,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -65063,7 +70789,7 @@ export interface operations { }; /** flight_specs */ flight?: { - /** Format: unix-time */ + /** @format unix-time */ departure_at?: number; passenger_name?: string; refundable?: boolean; @@ -65080,24 +70806,24 @@ export interface operations { /** fuel_specs */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; /** lodging_specs */ lodging?: { - /** Format: unix-time */ + /** @format unix-time */ check_in_at?: number; nights?: number; }; receipt?: { description?: string; - /** Format: decimal */ + /** @format decimal */ quantity?: string; total?: number; unit_cost?: number; @@ -65143,8 +70869,8 @@ export interface operations { /** @description Card associated with this unlinked refund transaction. */ card: string; /** - * Format: currency * @description The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -65186,19 +70912,19 @@ export interface operations { reported_breakdown?: { /** fleet_reported_breakdown_fuel_specs */ fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_non_fuel_specs */ non_fuel?: { - /** Format: decimal */ + /** @format decimal */ gross_amount_decimal?: string; }; /** fleet_reported_breakdown_tax_specs */ tax?: { - /** Format: decimal */ + /** @format decimal */ local_amount_decimal?: string; - /** Format: decimal */ + /** @format decimal */ national_amount_decimal?: string; }; }; @@ -65207,7 +70933,7 @@ export interface operations { }; /** flight_specs */ flight?: { - /** Format: unix-time */ + /** @format unix-time */ departure_at?: number; passenger_name?: string; refundable?: boolean; @@ -65224,24 +70950,24 @@ export interface operations { /** fuel_specs */ fuel?: { industry_product_code?: string; - /** Format: decimal */ + /** @format decimal */ quantity_decimal?: string; /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; - /** Format: decimal */ + /** @format decimal */ unit_cost_decimal?: string; }; /** lodging_specs */ lodging?: { - /** Format: unix-time */ + /** @format unix-time */ check_in_at?: number; nights?: number; }; receipt?: { description?: string; - /** Format: decimal */ + /** @format decimal */ quantity?: string; total?: number; unit_cost?: number; @@ -65446,7 +71172,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/test_helpers/test_clocks + */ url: string; }; }; @@ -65475,8 +71204,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The initial frozen time for this test clock. + * @format unix-time */ frozen_time: number; /** @description The name for this test clock. */ @@ -65593,8 +71322,8 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * Format: unix-time * @description The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future. + * @format unix-time */ frozen_time: number; }; @@ -66112,8 +71841,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -66178,8 +71907,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -66282,7 +72011,7 @@ export interface operations { directors_provided?: boolean; /** company_directorship_declaration */ directorship_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -66296,7 +72025,7 @@ export interface operations { owners_provided?: boolean; /** company_ownership_declaration */ ownership_declaration?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string; @@ -66420,7 +72149,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; - /** Format: currency */ + /** @format currency */ currency?: string; payment_method?: string; routing_number?: string; @@ -66465,7 +72194,7 @@ export interface operations { additional_tos_acceptances?: { /** settings_terms_of_service_specs */ account?: { - /** Format: unix-time */ + /** @format unix-time */ date?: number; ip?: string; user_agent?: string | ""; @@ -66695,7 +72424,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/topups + */ url: string; }; }; @@ -66932,7 +72664,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/transfers + */ url: string; }; }; @@ -66961,8 +72696,8 @@ export interface operations { /** @description A positive integer in cents (or local equivalent) representing how much to transfer. */ amount?: number; /** - * Format: currency * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -67602,7 +73337,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/treasury/financial_accounts + */ url: string; }; }; @@ -68146,8 +73884,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -68315,7 +74053,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/treasury/outbound_payments + */ url: string; }; }; @@ -68344,8 +74085,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in. */ @@ -68589,8 +74330,8 @@ export interface operations { /** @description Amount (in cents) to be transferred. */ amount: number; /** - * Format: currency * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + * @format currency */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -68980,7 +74721,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/treasury/transaction_entries + */ url: string; }; }; @@ -69185,7 +74929,10 @@ export interface operations { * @enum {string} */ object: "list"; - /** @description The URL where this list can be accessed. */ + /** + * @description The URL where this list can be accessed. + * @pattern ^/v1/webhook_endpoints + */ url: string; }; }; diff --git a/packages/openapi-typescript/src/lib/ts.ts b/packages/openapi-typescript/src/lib/ts.ts index d1f41eb88..ae8eba2dd 100644 --- a/packages/openapi-typescript/src/lib/ts.ts +++ b/packages/openapi-typescript/src/lib/ts.ts @@ -33,8 +33,9 @@ export interface AnnotatedSchemaObject { enum?: unknown[]; // jsdoc without value example?: string; // jsdoc with value examples?: unknown; - format?: string; // not jsdoc - nullable?: boolean; // Node information + format?: string; // jsdoc with value + nullable?: boolean; // jsdoc without value + pattern?: string; // jsdoc with value summary?: string; // not jsdoc title?: string; // not jsdoc type?: string | string[]; // Type of node @@ -51,25 +52,24 @@ export function addJSDocComment(schemaObject: AnnotatedSchemaObject, node: ts.Pr } const output: string[] = []; - // Not JSDoc tags: [title, format] + // Not JSDoc tags: [title] if (schemaObject.title) { output.push(schemaObject.title.trim().replace(LB_RE, "\n * ")); } if (schemaObject.summary) { output.push(schemaObject.summary.trim().replace(LB_RE, "\n * ")); } - if (schemaObject.format) { - output.push(`Format: ${schemaObject.format}`); - } // JSDoc tags without value - // 'Deprecated' without value if (schemaObject.deprecated) { output.push("@deprecated"); } + if (schemaObject.nullable) { + output.push("@nullable"); + } // JSDoc tags with value - const supportedJsDocTags = ["description", "default", "example"] as const; + const supportedJsDocTags = ["description", "default", "example", "format", "pattern"] as const; for (const field of supportedJsDocTags) { const allowEmptyString = field === "default" || field === "example"; if (schemaObject[field] === undefined) { diff --git a/packages/openapi-typescript/test/index.test.ts b/packages/openapi-typescript/test/index.test.ts index ea8f55426..84b07db4c 100644 --- a/packages/openapi-typescript/test/index.test.ts +++ b/packages/openapi-typescript/test/index.test.ts @@ -963,13 +963,22 @@ export type operations = Record;`, export type webhooks = Record; export interface components { schemas: { - /** Nullable object */ + /** + * Nullable object + * @nullable + */ obj1: { id?: string; } | null; - /** Nullable empty object */ + /** + * Nullable empty object + * @nullable + */ obj2: Record | null; - /** Nullable string */ + /** + * Nullable string + * @nullable + */ str: string | null; }; responses: never; diff --git a/packages/openapi-typescript/test/lib/ts.test.ts b/packages/openapi-typescript/test/lib/ts.test.ts index 79e5b4571..33b7e5b6c 100644 --- a/packages/openapi-typescript/test/lib/ts.test.ts +++ b/packages/openapi-typescript/test/lib/ts.test.ts @@ -142,6 +142,63 @@ describe("addJSDocComment", () => { * } */ comment: boolean; +}`); + }); + + test("@format tag", () => { + const property = ts.factory.createPropertySignature(undefined, "comment", undefined, STRING); + addJSDocComment({ format: "date-time" }, property); + expect(astToString(ts.factory.createTypeLiteralNode([property])).trim()).toBe(`{ + /** @format date-time */ + comment: string; +}`); + }); + + test("@pattern tag", () => { + const property = ts.factory.createPropertySignature(undefined, "comment", undefined, STRING); + addJSDocComment({ pattern: "^[a-z]+$" }, property); + expect(astToString(ts.factory.createTypeLiteralNode([property])).trim()).toBe(`{ + /** @pattern ^[a-z]+$ */ + comment: string; +}`); + }); + + test("@nullable tag", () => { + const property = ts.factory.createPropertySignature(undefined, "comment", undefined, STRING); + addJSDocComment({ nullable: true }, property); + expect(astToString(ts.factory.createTypeLiteralNode([property])).trim()).toBe(`{ + /** @nullable */ + comment: string; +}`); + }); + + test("nullable false produces no output", () => { + const property = ts.factory.createPropertySignature(undefined, "comment", undefined, STRING); + addJSDocComment({ nullable: false }, property); + expect(astToString(ts.factory.createTypeLiteralNode([property])).trim()).toBe(`{ + comment: string; +}`); + }); + + test("combined format, pattern, nullable with description", () => { + const property = ts.factory.createPropertySignature(undefined, "comment", undefined, STRING); + addJSDocComment( + { + description: "User email", + format: "email", + pattern: "^[a-z]+@[a-z]+\\.[a-z]+$", + nullable: true, + }, + property, + ); + expect(astToString(ts.factory.createTypeLiteralNode([property])).trim()).toBe(`{ + /** + * @nullable + * @description User email + * @format email + * @pattern ^[a-z]+@[a-z]+\\.[a-z]+$ + */ + comment: string; }`); }); }); diff --git a/packages/openapi-typescript/test/node-api.test.ts b/packages/openapi-typescript/test/node-api.test.ts index b22f8ad18..d3af995d5 100644 --- a/packages/openapi-typescript/test/node-api.test.ts +++ b/packages/openapi-typescript/test/node-api.test.ts @@ -363,7 +363,7 @@ export type operations = Record;`, export type webhooks = Record; export interface components { schemas: { - /** Format: date-time */ + /** @format date-time */ Date: Date; }; responses: never; @@ -404,7 +404,7 @@ export type operations = Record;`, export type webhooks = Record; export interface components { schemas: { - /** Format: date-time */ + /** @format date-time */ Date?: Date; }; responses: never; @@ -508,7 +508,7 @@ export interface components { Blob: { content: { "application/json": { - /** Format: binary */ + /** @format binary */ blob?: Blob; }; }; @@ -552,7 +552,7 @@ export type operations = Record;`, export type webhooks = Record; export interface components { schemas: { - /** Format: date-time */ + /** @format date-time */ Date: DateOrTime; /** @enum {string} */ Set: Set<"low" | "medium" | "high">; @@ -645,11 +645,12 @@ export interface components { * @minLength 1 * @pattern ^[a-zA-Z0-9]+$ */ + /** @pattern ^[a-zA-Z0-9]+$ */ name: string; /** * @format email */ - /** Format: email */ + /** @format email */ email: string; /** * @minimum 0 @@ -738,7 +739,7 @@ export interface components { schemas: { User: { name: string; - /** Format: email */ + /** @format email */ email?: string; }; }; diff --git a/packages/openapi-typescript/test/transform/components-object.test.ts b/packages/openapi-typescript/test/transform/components-object.test.ts index d0cd85e94..1b4a6e366 100644 --- a/packages/openapi-typescript/test/transform/components-object.test.ts +++ b/packages/openapi-typescript/test/transform/components-object.test.ts @@ -818,7 +818,7 @@ export type ItemDTO = components['schemas']['ItemDTO']; want: `{ schemas: { Alpha: { - /** Format: date-time */ + /** @format date-time */ z?: Date | null; }; }; diff --git a/packages/openapi-typescript/test/transform/schema-object/object.test.ts b/packages/openapi-typescript/test/transform/schema-object/object.test.ts index 0ef611a95..c429e921d 100644 --- a/packages/openapi-typescript/test/transform/schema-object/object.test.ts +++ b/packages/openapi-typescript/test/transform/schema-object/object.test.ts @@ -418,6 +418,7 @@ describe("transformSchemaObject > object", () => { }, }, want: `{ + /** @nullable */ readonly array?: readonly { readonly [key: string]: unknown; }[] | null;